From cf02ce1df96c5765c5d2bfabb7cd9a730df0df35 Mon Sep 17 00:00:00 2001 From: ZakaryCode Date: Fri, 2 Feb 2024 10:27:05 +0800 Subject: [PATCH] feat(4.x): merge 4.x into next --- docusaurus.config.js | 2 +- src/pages/versions.js | 2 +- .../version-4.x/CONTRIBUTING-GUIDE.md | 247 -- versioned_docs/version-4.x/CONTRIBUTING.md | 81 - .../version-4.x/GETTING-STARTED.mdx | 711 ----- versioned_docs/version-4.x/README.mdx | 151 - versioned_docs/version-4.x/apis/General.md | 172 - versioned_docs/version-4.x/apis/about/desc.md | 26 - versioned_docs/version-4.x/apis/about/env.md | 27 - .../version-4.x/apis/about/events.md | 46 - .../version-4.x/apis/about/tarocomponent.md | 298 -- .../version-4.x/apis/ad/InterstitialAd.md | 213 -- .../version-4.x/apis/ad/RewardedVideoAd.md | 207 -- .../apis/ad/createInterstitialAd.md | 29 - .../apis/ad/createRewardedVideoAd.md | 30 - .../version-4.x/apis/ai/face/faceDetect.md | 90 - .../apis/ai/face/initFaceDetect.md | 30 - .../apis/ai/face/stopFaceDetect.md | 30 - .../apis/ai/inference/InferenceSession.md | 153 - .../ai/inference/createInferenceSession.md | 42 - .../apis/ai/inference/getInferenceEnvInfo.md | 36 - .../apis/ai/visionkit/VKBodyAnchor.md | 66 - .../version-4.x/apis/ai/visionkit/VKCamera.md | 41 - .../apis/ai/visionkit/VKDepthAnchor.md | 44 - .../apis/ai/visionkit/VKFaceAnchor.md | 66 - .../version-4.x/apis/ai/visionkit/VKFrame.md | 84 - .../apis/ai/visionkit/VKHandAnchor.md | 93 - .../apis/ai/visionkit/VKMarkerAnchor.md | 36 - .../apis/ai/visionkit/VKOCRAnchor.md | 34 - .../apis/ai/visionkit/VKOSDAnchor.md | 55 - .../apis/ai/visionkit/VKPlaneAnchor.md | 45 - .../apis/ai/visionkit/VKSession.md | 664 ---- .../apis/ai/visionkit/createVKSession.md | 57 - .../apis/ai/visionkit/isVKSupport.md | 31 - .../apis/alipay/getOpenUserInfo.md | 32 - .../version-4.x/apis/alipay/tradePay.md | 46 - .../apis/base/arrayBufferToBase64.md | 29 - .../apis/base/base64ToArrayBuffer.md | 29 - .../version-4.x/apis/base/canIUse.md | 36 - .../version-4.x/apis/base/canIUseWebp.md | 16 - .../apis/base/crypto/UserCryptoManager.md | 113 - .../apis/base/crypto/getRandomValues.md | 32 - .../apis/base/crypto/getUserCryptoManager.md | 16 - .../version-4.x/apis/base/debug/LogManager.md | 94 - .../apis/base/debug/RealtimeLogManager.md | 141 - .../apis/base/debug/RealtimeTagLogManager.md | 110 - .../version-4.x/apis/base/debug/console.md | 143 - .../apis/base/debug/getLogManager.md | 46 - .../apis/base/debug/getRealtimeLogManager.md | 23 - .../apis/base/debug/setEnableDebug.md | 50 - versioned_docs/version-4.x/apis/base/env.md | 14 - .../version-4.x/apis/base/env/env.md | 14 - .../apis/base/performance/EntryList.md | 66 - .../apis/base/performance/Performance.md | 100 - .../apis/base/performance/PerformanceEntry.md | 60 - .../base/performance/PerformanceObserver.md | 71 - .../apis/base/performance/getPerformance.md | 30 - .../apis/base/performance/preloadAssets.md | 45 - .../base/performance/preloadSkylineView.md | 30 - .../apis/base/performance/preloadWebview.md | 30 - .../base/performance/reportPerformance.md | 31 - .../version-4.x/apis/base/preload.md | 32 - .../base/system/getAppAuthorizeSetting.md | 68 - .../apis/base/system/getAppBaseInfo.md | 59 - .../apis/base/system/getDeviceInfo.md | 46 - .../apis/base/system/getRendererUserAgent.md | 37 - .../apis/base/system/getSkylineInfo.md | 39 - .../apis/base/system/getSkylineInfoSync.md | 27 - .../apis/base/system/getSystemInfo.md | 124 - .../apis/base/system/getSystemInfoAsync.md | 113 - .../apis/base/system/getSystemInfoSync.md | 102 - .../apis/base/system/getSystemSetting.md | 49 - .../apis/base/system/getWindowInfo.md | 47 - .../base/system/openAppAuthorizeSetting.md | 40 - .../base/system/openSystemBluetoothSetting.md | 40 - .../apis/base/update/UpdateManager.md | 134 - .../apis/base/update/getUpdateManager.md | 42 - .../apis/base/update/updateWeChatApp.md | 30 - .../apis/base/weapp/app-event/offAppHide.md | 22 - .../apis/base/weapp/app-event/offAppShow.md | 22 - .../app-event/offAudioInterruptionBegin.md | 22 - .../app-event/offAudioInterruptionEnd.md | 22 - .../apis/base/weapp/app-event/offError.md | 22 - .../base/weapp/app-event/offPageNotFound.md | 22 - .../base/weapp/app-event/offThemeChange.md | 22 - .../weapp/app-event/offUnhandledRejection.md | 22 - .../apis/base/weapp/app-event/onAppHide.md | 22 - .../apis/base/weapp/app-event/onAppShow.md | 92 - .../app-event/onAudioInterruptionBegin.md | 22 - .../weapp/app-event/onAudioInterruptionEnd.md | 22 - .../apis/base/weapp/app-event/onError.md | 34 - .../base/weapp/app-event/onPageNotFound.md | 47 - .../base/weapp/app-event/onThemeChange.md | 47 - .../weapp/app-event/onUnhandledRejection.md | 42 - .../weapp/life-cycle/getEnterOptionsSync.md | 78 - .../weapp/life-cycle/getLaunchOptionsSync.md | 78 - .../version-4.x/apis/canvas/Canvas.md | 132 - .../version-4.x/apis/canvas/CanvasContext.md | 1636 ---------- .../version-4.x/apis/canvas/CanvasGradient.md | 55 - .../version-4.x/apis/canvas/Color.md | 169 - .../version-4.x/apis/canvas/Image.md | 27 - .../version-4.x/apis/canvas/ImageData.md | 24 - .../apis/canvas/OffscreenCanvas.md | 52 - .../version-4.x/apis/canvas/Path2D.md | 10 - .../apis/canvas/RenderingContext.md | 15 - .../apis/canvas/canvasGetImageData.md | 63 - .../apis/canvas/canvasPutImageData.md | 51 - .../apis/canvas/canvasToTempFilePath.md | 96 - .../apis/canvas/createCanvasContext.md | 51 - .../version-4.x/apis/canvas/createContext.md | 13 - .../apis/canvas/createOffscreenCanvas.md | 36 - .../version-4.x/apis/canvas/drawCanvas.md | 13 - versioned_docs/version-4.x/apis/cloud/DB.md | 2843 ----------------- .../version-4.x/apis/cloud/cloud.md | 573 ---- .../apis/data-analysis/getCommonConfig.md | 59 - .../apis/data-analysis/getExptInfoSync.md | 28 - .../apis/data-analysis/reportAnalytics.md | 32 - .../apis/data-analysis/reportEvent.md | 32 - .../apis/data-analysis/reportMonitor.md | 32 - .../accelerometer/offAccelerometerChange.md | 22 - .../accelerometer/onAccelerometerChange.md | 50 - .../accelerometer/startAccelerometer.md | 45 - .../device/accelerometer/stopAccelerometer.md | 36 - .../accessibility/checkIsOpenAccessibility.md | 36 - .../apis/device/battery/getBatteryInfo.md | 38 - .../apis/device/battery/getBatteryInfoSync.md | 25 - .../bluetooth-ble/closeBLEConnection.md | 48 - .../bluetooth-ble/createBLEConnection.md | 57 - .../getBLEDeviceCharacteristics.md | 75 - .../device/bluetooth-ble/getBLEDeviceRSSI.md | 37 - .../bluetooth-ble/getBLEDeviceServices.md | 59 - .../apis/device/bluetooth-ble/getBLEMTU.md | 63 - .../notifyBLECharacteristicValueChange.md | 66 - .../offBLECharacteristicValueChange.md | 22 - .../offBLEConnectionStateChange.md | 22 - .../device/bluetooth-ble/offBLEMTUChange.md | 22 - .../onBLECharacteristicValueChange.md | 62 - .../onBLEConnectionStateChange.md | 50 - .../device/bluetooth-ble/onBLEMTUChange.md | 49 - .../readBLECharacteristicValue.md | 57 - .../apis/device/bluetooth-ble/setBLEMTU.md | 53 - .../writeBLECharacteristicValue.md | 76 - .../BLEPeripheralServer.md | 517 --- .../createBLEPeripheralServer.md | 36 - .../offBLEPeripheralConnectionStateChanged.md | 22 - .../onBLEPeripheralConnectionStateChanged.md | 42 - .../device/bluetooth/closeBluetoothAdapter.md | 40 - .../bluetooth/getBluetoothAdapterState.md | 48 - .../device/bluetooth/getBluetoothDevices.md | 79 - .../bluetooth/getConnectedBluetoothDevices.md | 57 - .../bluetooth/isBluetoothDevicePaired.md | 31 - .../device/bluetooth/makeBluetoothPair.md | 35 - .../offBluetoothAdapterStateChange.md | 22 - .../bluetooth/offBluetoothDeviceFound.md | 22 - .../onBluetoothAdapterStateChange.md | 49 - .../bluetooth/onBluetoothDeviceFound.md | 80 - .../device/bluetooth/openBluetoothAdapter.md | 64 - .../startBluetoothDevicesDiscovery.md | 60 - .../stopBluetoothDevicesDiscovery.md | 46 - .../apis/device/calendar/addPhoneCalendar.md | 38 - .../device/calendar/addPhoneRepeatCalendar.md | 49 - .../apis/device/clipboard/getClipboardData.md | 55 - .../apis/device/clipboard/setClipboardData.md | 55 - .../apis/device/compass/offCompassChange.md | 22 - .../apis/device/compass/onCompassChange.md | 60 - .../apis/device/compass/startCompass.md | 36 - .../apis/device/compass/stopCompass.md | 36 - .../apis/device/contact/addPhoneContact.md | 62 - .../apis/device/contact/chooseContact.md | 38 - .../device/gyroscope/offGyroscopeChange.md | 22 - .../device/gyroscope/onGyroscopeChange.md | 42 - .../apis/device/gyroscope/startGyroscope.md | 41 - .../apis/device/gyroscope/stopGyroscope.md | 30 - .../apis/device/iBeacon/IBeaconInfo.md | 28 - .../apis/device/iBeacon/getBeacons.md | 37 - .../device/iBeacon/offBeaconServiceChange.md | 22 - .../apis/device/iBeacon/offBeaconUpdate.md | 22 - .../device/iBeacon/onBeaconServiceChange.md | 41 - .../apis/device/iBeacon/onBeaconUpdate.md | 40 - .../device/iBeacon/startBeaconDiscovery.md | 40 - .../device/iBeacon/stopBeaconDiscovery.md | 36 - .../device/keyboard/getSelectedTextRange.md | 48 - .../apis/device/keyboard/hideKeyboard.md | 40 - .../keyboard/offKeyboardHeightChange.md | 22 - .../device/keyboard/onKeyboardHeightChange.md | 46 - .../apis/device/memory/offMemoryWarning.md | 22 - .../apis/device/memory/onMemoryWarning.md | 58 - .../device/motion/offDeviceMotionChange.md | 22 - .../device/motion/onDeviceMotionChange.md | 42 - .../motion/startDeviceMotionListening.md | 39 - .../motion/stopDeviceMotionListening.md | 30 - .../apis/device/network/getLocalIPAddress.md | 47 - .../apis/device/network/getNetworkType.md | 65 - .../device/network/offNetworkStatusChange.md | 22 - .../device/network/offNetworkWeakChange.md | 22 - .../device/network/onNetworkStatusChange.md | 50 - .../device/network/onNetworkWeakChange.md | 52 - .../version-4.x/apis/device/nfc/IsoDep.md | 229 -- .../apis/device/nfc/MifareClassic.md | 196 -- .../apis/device/nfc/MifareUltralight.md | 196 -- .../version-4.x/apis/device/nfc/NFCAdapter.md | 242 -- .../version-4.x/apis/device/nfc/Ndef.md | 215 -- .../version-4.x/apis/device/nfc/NfcA.md | 262 -- .../version-4.x/apis/device/nfc/NfcB.md | 196 -- .../version-4.x/apis/device/nfc/NfcF.md | 196 -- .../version-4.x/apis/device/nfc/NfcV.md | 196 -- .../apis/device/nfc/getHCEState.md | 40 - .../apis/device/nfc/getNFCAdapter.md | 16 - .../apis/device/nfc/offHCEMessage.md | 22 - .../apis/device/nfc/onHCEMessage.md | 51 - .../apis/device/nfc/sendHCEMessage.md | 48 - .../version-4.x/apis/device/nfc/startHCE.md | 42 - .../version-4.x/apis/device/nfc/stopHCE.md | 40 - .../apis/device/phone/makePhoneCall.md | 39 - .../version-4.x/apis/device/scan/scanCode.md | 98 - .../apis/device/screen/getScreenBrightness.md | 39 - .../device/screen/getScreenRecordingState.md | 53 - .../screen/offScreenRecordingStateChanged.md | 22 - .../device/screen/offUserCaptureScreen.md | 22 - .../screen/onScreenRecordingStateChanged.md | 51 - .../apis/device/screen/onUserCaptureScreen.md | 42 - .../apis/device/screen/setKeepScreenOn.md | 46 - .../apis/device/screen/setScreenBrightness.md | 37 - .../device/screen/setVisualEffectOnCapture.md | 31 - .../version-4.x/apis/device/sms/sendSms.md | 32 - .../apis/device/vibrate/vibrateLong.md | 36 - .../apis/device/vibrate/vibrateShort.md | 39 - .../version-4.x/apis/device/wifi/WifiInfo.md | 19 - .../apis/device/wifi/connectWifi.md | 47 - .../apis/device/wifi/getConnectedWifi.md | 38 - .../apis/device/wifi/getWifiList.md | 32 - .../apis/device/wifi/offGetWifiList.md | 22 - .../apis/device/wifi/offWifiConnected.md | 22 - .../wifi/offWifiConnectedWithPartialInfo.md | 22 - .../apis/device/wifi/onGetWifiList.md | 40 - .../apis/device/wifi/onWifiConnected.md | 40 - .../wifi/onWifiConnectedWithPartialInfo.md | 40 - .../apis/device/wifi/setWifiList.md | 67 - .../version-4.x/apis/device/wifi/startWifi.md | 40 - .../version-4.x/apis/device/wifi/stopWifi.md | 40 - .../version-4.x/apis/ext/getExtConfig.md | 52 - .../version-4.x/apis/ext/getExtConfigSync.md | 35 - .../apis/files/FileSystemManager.md | 1440 --------- .../version-4.x/apis/files/ReadResult.md | 23 - .../version-4.x/apis/files/Stats.md | 51 - .../version-4.x/apis/files/WriteResult.md | 22 - .../version-4.x/apis/files/getFileInfo.md | 58 - .../apis/files/getFileSystemManager.md | 16 - .../apis/files/getSavedFileInfo.md | 52 - .../apis/files/getSavedFileList.md | 58 - .../version-4.x/apis/files/openDocument.md | 64 - .../version-4.x/apis/files/removeSavedFile.md | 54 - .../version-4.x/apis/files/saveFile.md | 62 - .../version-4.x/apis/files/saveFileToDisk.md | 45 - .../version-4.x/apis/framework/App.md | 8 - .../version-4.x/apis/framework/Page.md | 13 - .../version-4.x/apis/framework/getApp.md | 34 - .../apis/framework/getCurrentPages.md | 25 - versioned_docs/version-4.x/apis/index.md | 1420 -------- .../apis/location/chooseLocation.md | 66 - .../version-4.x/apis/location/choosePoi.md | 41 - .../apis/location/getFuzzyLocation.md | 57 - .../version-4.x/apis/location/getLocation.md | 75 - .../apis/location/offLocationChange.md | 22 - .../apis/location/offLocationChangeError.md | 22 - .../apis/location/onLocationChange.md | 65 - .../apis/location/onLocationChangeError.md | 41 - .../version-4.x/apis/location/openLocation.md | 53 - .../apis/location/startLocationUpdate.md | 35 - .../location/startLocationUpdateBackground.md | 36 - .../apis/location/stopLocationUpdate.md | 30 - .../apis/media/audio/AudioBuffer.md | 105 - .../apis/media/audio/AudioContext.md | 80 - .../apis/media/audio/InnerAudioContext.md | 560 ---- .../apis/media/audio/MediaAudioPlayer.md | 95 - .../apis/media/audio/WebAudioContext.md | 443 --- .../apis/media/audio/WebAudioContextNode.md | 62 - .../apis/media/audio/createAudioContext.md | 30 - .../media/audio/createInnerAudioContext.md | 31 - .../media/audio/createMediaAudioPlayer.md | 47 - .../apis/media/audio/createWebAudioContext.md | 59 - .../media/audio/getAvailableAudioSources.md | 51 - .../apis/media/audio/pauseVoice.md | 48 - .../version-4.x/apis/media/audio/playVoice.md | 46 - .../apis/media/audio/setInnerAudioOption.md | 32 - .../version-4.x/apis/media/audio/stopVoice.md | 57 - .../BackgroundAudioManager.md | 215 -- .../getBackgroundAudioManager.md | 30 - .../getBackgroundAudioPlayerState.md | 64 - .../onBackgroundAudioPause.md | 22 - .../background-audio/onBackgroundAudioPlay.md | 22 - .../background-audio/onBackgroundAudioStop.md | 26 - .../background-audio/pauseBackgroundAudio.md | 36 - .../background-audio/playBackgroundAudio.md | 43 - .../background-audio/seekBackgroundAudio.md | 39 - .../background-audio/stopBackgroundAudio.md | 36 - .../apis/media/camera/CameraContext.md | 223 -- .../apis/media/camera/CameraFrameListener.md | 67 - .../apis/media/camera/createCameraContext.md | 30 - .../apis/media/editor/EditorContext.md | 388 --- .../apis/media/image/chooseImage.md | 87 - .../apis/media/image/chooseMessageFile.md | 82 - .../apis/media/image/compressImage.md | 50 - .../version-4.x/apis/media/image/cropImage.md | 63 - .../version-4.x/apis/media/image/editImage.md | 45 - .../apis/media/image/getImageInfo.md | 78 - .../apis/media/image/previewImage.md | 45 - .../apis/media/image/previewMedia.md | 50 - .../media/image/saveImageToPhotosAlbum.md | 39 - .../apis/media/live/LivePlayerContext.md | 381 --- .../apis/media/live/LivePusherContext.md | 425 --- .../media/live/createLivePlayerContext.md | 23 - .../media/live/createLivePusherContext.md | 16 - .../version-4.x/apis/media/map/MapContext.md | 849 ----- .../apis/media/map/createMapContext.md | 29 - .../media/media-recorder/MediaRecorder.md | 167 - .../media-recorder/createMediaRecorder.md | 36 - .../apis/media/recorder/RecorderManager.md | 328 -- .../apis/media/recorder/getRecorderManager.md | 45 - .../apis/media/recorder/startRecord.md | 52 - .../apis/media/recorder/stopRecord.md | 47 - .../apis/media/video-decoder/VideoDecoder.md | 171 - .../media/video-decoder/createVideoDecoder.md | 16 - .../media/video-processing/MediaContainer.md | 105 - .../apis/media/video-processing/MediaTrack.md | 34 - .../video-processing/createMediaContainer.md | 16 - .../apis/media/video/VideoContext.md | 234 -- .../apis/media/video/chooseMedia.md | 97 - .../apis/media/video/chooseVideo.md | 72 - .../apis/media/video/compressVideo.md | 77 - .../apis/media/video/createVideoContext.md | 29 - .../apis/media/video/getVideoInfo.md | 81 - .../apis/media/video/openVideoEditor.md | 48 - .../media/video/saveVideoToPhotosAlbum.md | 46 - .../apis/media/voip/exitVoIPChat.md | 30 - .../apis/media/voip/join1v1Chat.md | 97 - .../apis/media/voip/joinVoIPChat.md | 88 - .../apis/media/voip/offVoIPChatInterrupted.md | 22 - .../media/voip/offVoIPChatMembersChanged.md | 22 - .../media/voip/offVoIPChatSpeakersChanged.md | 22 - .../media/voip/offVoIPChatStateChanged.md | 22 - .../media/voip/offVoIPVideoMembersChanged.md | 22 - .../apis/media/voip/onVoIPChatInterrupted.md | 42 - .../media/voip/onVoIPChatMembersChanged.md | 42 - .../media/voip/onVoIPChatSpeakersChanged.md | 42 - .../apis/media/voip/onVoIPChatStateChanged.md | 43 - .../media/voip/onVoIPVideoMembersChanged.md | 42 - .../apis/media/voip/setEnable1v1Chat.md | 46 - .../media/voip/subscribeVoIPVideoMembers.md | 31 - .../media/voip/updateVoIPChatMuteConfig.md | 40 - .../apis/navigate/exitMiniProgram.md | 36 - .../apis/navigate/navigateBackMiniProgram.md | 46 - .../apis/navigate/navigateToMiniProgram.md | 71 - .../apis/navigate/openBusinessView.md | 103 - .../apis/navigate/openEmbeddedMiniProgram.md | 53 - .../apis/network/download/DownloadTask.md | 162 - .../apis/network/download/downloadFile.md | 66 - .../mdns/offLocalServiceDiscoveryStop.md | 34 - .../apis/network/mdns/offLocalServiceFound.md | 34 - .../apis/network/mdns/offLocalServiceLost.md | 34 - .../mdns/offLocalServiceResolveFail.md | 34 - .../mdns/onLocalServiceDiscoveryStop.md | 34 - .../apis/network/mdns/onLocalServiceFound.md | 43 - .../apis/network/mdns/onLocalServiceLost.md | 41 - .../network/mdns/onLocalServiceResolveFail.md | 41 - .../mdns/startLocalServiceDiscovery.md | 40 - .../network/mdns/stopLocalServiceDiscovery.md | 36 - .../apis/network/request/RequestTask.md | 200 -- .../apis/network/request/addInterceptor.md | 56 - .../apis/network/request/cleanInterceptors.md | 20 - .../apis/network/request/request.md | 181 -- .../version-4.x/apis/network/tcp/TCPSocket.md | 324 -- .../apis/network/tcp/createTCPSocket.md | 23 - .../version-4.x/apis/network/udp/UDPSocket.md | 391 --- .../apis/network/udp/createUDPSocket.md | 16 - .../apis/network/upload/UploadTask.md | 166 - .../apis/network/upload/uploadFile.md | 95 - .../apis/network/websocket/SocketTask.md | 225 -- .../apis/network/websocket/closeSocket.md | 49 - .../apis/network/websocket/connectSocket.md | 78 - .../apis/network/websocket/onSocketClose.md | 58 - .../apis/network/websocket/onSocketError.md | 54 - .../apis/network/websocket/onSocketMessage.md | 51 - .../apis/network/websocket/onSocketOpen.md | 51 - .../network/websocket/sendSocketMessage.md | 57 - .../open-api/account/getAccountInfoSync.md | 56 - .../apis/open-api/address/chooseAddress.md | 62 - .../apis/open-api/authorize/authorize.md | 50 - .../authorize/authorizeForMiniProgram.md | 50 - .../version-4.x/apis/open-api/card/addCard.md | 80 - .../version-4.x/apis/open-api/card/card.md | 35 - .../apis/open-api/card/openCard.md | 55 - .../open-api/channels/getChannelsLiveInfo.md | 49 - .../channels/getChannelsLiveNoticeInfo.md | 50 - .../open-api/channels/getChannelsShareKey.md | 46 - .../open-api/channels/openChannelsActivity.md | 32 - .../open-api/channels/openChannelsEvent.md | 32 - .../open-api/channels/openChannelsLive.md | 33 - .../channels/openChannelsUserProfile.md | 31 - .../open-api/channels/reserveChannelsLive.md | 28 - .../openCustomerServiceChat.md | 52 - .../open-api/device-voip/getDeviceVoIPList.md | 45 - .../open-api/device-voip/requestDeviceVoIP.md | 36 - .../facial/checkIsSupportFacialRecognition.md | 36 - .../facial/startFacialRecognitionVerify.md | 39 - ...rtFacialRecognitionVerifyAndUploadVideo.md | 39 - .../open-api/favorites/addFileToFavorites.md | 65 - .../open-api/favorites/addVideoToFavorites.md | 65 - .../apis/open-api/group/getGroupEnterInfo.md | 67 - .../apis/open-api/invoice/chooseInvoice.md | 49 - .../open-api/invoice/chooseInvoiceTitle.md | 60 - .../license-plate/chooseLicensePlate.md | 36 - .../apis/open-api/login/checkSession.md | 48 - .../version-4.x/apis/open-api/login/login.md | 58 - .../apis/open-api/login/pluginLogin.md | 36 - .../checkIsAddedToMyMiniProgram.md | 36 - .../open-api/privacy/getPrivacySetting.md | 37 - .../privacy/onNeedPrivacyAuthorization.md | 56 - .../open-api/privacy/openPrivacyContract.md | 30 - .../privacy/requirePrivacyAuthorize.md | 30 - .../open-api/redpackage/showRedPackage.md | 31 - .../apis/open-api/settings/AuthSetting.md | 23 - .../open-api/settings/SubscriptionsSetting.md | 55 - .../apis/open-api/settings/getSetting.md | 54 - .../apis/open-api/settings/openSetting.md | 55 - .../soter/checkIsSoterEnrolledInDevice.md | 57 - .../checkIsSupportSoterAuthentication.md | 57 - .../soter/startSoterAuthentication.md | 90 - .../requestSubscribeDeviceMessage.md | 87 - .../requestSubscribeMessage.md | 78 - .../apis/open-api/user-info/UserInfo.md | 38 - .../apis/open-api/user-info/getUserInfo.md | 85 - .../apis/open-api/user-info/getUserProfile.md | 70 - .../apis/open-api/werun/getWeRunData.md | 78 - .../apis/open-api/werun/shareToWeRun.md | 40 - .../apis/payment/faceVerifyForPay.md | 22 - .../apis/payment/requestOrderPayment.md | 62 - .../apis/payment/requestPayment.md | 57 - .../version-4.x/apis/qq/openQzonePublish.md | 61 - .../version-4.x/apis/route/EventChannel.md | 90 - .../version-4.x/apis/route/navigateBack.md | 51 - .../version-4.x/apis/route/navigateTo.md | 56 - .../version-4.x/apis/route/reLaunch.md | 39 - .../version-4.x/apis/route/redirectTo.md | 41 - .../version-4.x/apis/route/switchTab.md | 53 - .../apis/share/authPrivateMessage.md | 61 - .../version-4.x/apis/share/getShareInfo.md | 54 - .../version-4.x/apis/share/hideShareMenu.md | 37 - .../version-4.x/apis/share/offCopyUrl.md | 24 - .../version-4.x/apis/share/onCopyUrl.md | 42 - .../apis/share/shareFileMessage.md | 32 - .../apis/share/shareVideoMessage.md | 63 - .../apis/share/showShareImageMenu.md | 44 - .../version-4.x/apis/share/showShareMenu.md | 40 - .../version-4.x/apis/share/updateShareMenu.md | 60 - .../version-4.x/apis/skyline/Snapshot.md | 60 - .../getBackgroundFetchData.md | 43 - .../getBackgroundFetchToken.md | 37 - .../background-fetch/onBackgroundFetchData.md | 51 - .../setBackgroundFetchToken.md | 31 - .../apis/storage/batchGetStorage.md | 42 - .../apis/storage/batchGetStorageSync.md | 35 - .../apis/storage/batchSetStorage.md | 51 - .../apis/storage/batchSetStorageSync.md | 45 - .../storage/cache-manager/CacheManager.md | 333 -- .../cache-manager/createCacheManager.md | 45 - .../version-4.x/apis/storage/clearStorage.md | 36 - .../apis/storage/clearStorageSync.md | 26 - .../apis/storage/createBufferURL.md | 22 - .../version-4.x/apis/storage/getStorage.md | 49 - .../apis/storage/getStorageInfo.md | 50 - .../apis/storage/getStorageInfoSync.md | 40 - .../apis/storage/getStorageSync.md | 35 - .../version-4.x/apis/storage/removeStorage.md | 42 - .../apis/storage/removeStorageSync.md | 32 - .../apis/storage/revokeBufferURL.md | 22 - .../version-4.x/apis/storage/setStorage.md | 46 - .../apis/storage/setStorageSync.md | 42 - .../version-4.x/apis/swan/setPageInfo.md | 96 - .../apis/taro.extend/eventCenter.md | 14 - .../apis/taro.extend/getAppInfo.md | 26 - .../apis/taro.extend/getCurrentInstance.md | 29 - .../version-4.x/apis/taro.extend/getEnv.md | 14 - .../apis/taro.extend/getEnvInfoSync.md | 10 - .../apis/taro.extend/getRenderer.md | 14 - .../version-4.x/apis/taro.extend/getTabBar.md | 20 - .../apis/taro.extend/initPxTransform.md | 20 - .../apis/taro.extend/interceptorify.md | 127 - .../apis/taro.extend/pxTransform.md | 20 - .../apis/taro.extend/requirePlugin.md | 20 - .../apis/taro.extend/setGlobalDataPlugin.md | 38 - .../apis/taro.hooks/useAddToFavorites.md | 20 - .../version-4.x/apis/taro.hooks/useDidHide.md | 20 - .../version-4.x/apis/taro.hooks/useDidShow.md | 20 - .../version-4.x/apis/taro.hooks/useError.md | 20 - .../version-4.x/apis/taro.hooks/useLaunch.md | 20 - .../version-4.x/apis/taro.hooks/useLoad.md | 20 - .../apis/taro.hooks/useOptionMenuClick.md | 20 - .../apis/taro.hooks/usePageNotFound.md | 22 - .../apis/taro.hooks/usePageScroll.md | 20 - .../apis/taro.hooks/usePullDownRefresh.md | 20 - .../apis/taro.hooks/usePullIntercept.md | 20 - .../apis/taro.hooks/useReachBottom.md | 20 - .../version-4.x/apis/taro.hooks/useReady.md | 21 - .../version-4.x/apis/taro.hooks/useResize.md | 20 - .../version-4.x/apis/taro.hooks/useRouter.md | 20 - .../apis/taro.hooks/useSaveExitState.md | 20 - .../apis/taro.hooks/useShareAppMessage.md | 20 - .../apis/taro.hooks/useShareTimeline.md | 20 - .../apis/taro.hooks/useTabItemTap.md | 20 - .../apis/taro.hooks/useTitleClick.md | 20 - .../apis/taro.hooks/useUnhandledRejection.md | 20 - .../version-4.x/apis/taro.hooks/useUnload.md | 20 - .../apis/ui/animation/Animation.md | 577 ---- .../apis/ui/animation/createAnimation.md | 55 - .../apis/ui/background/setBackgroundColor.md | 47 - .../ui/background/setBackgroundTextStyle.md | 41 - .../apis/ui/custom-component/nextTick.md | 36 - .../version-4.x/apis/ui/fonts/loadFontFace.md | 78 - .../interaction/disableAlertBeforeUnload.md | 30 - .../ui/interaction/enableAlertBeforeUnload.md | 25 - .../apis/ui/interaction/hideLoading.md | 42 - .../apis/ui/interaction/hideToast.md | 31 - .../apis/ui/interaction/showActionSheet.md | 58 - .../apis/ui/interaction/showLoading.md | 47 - .../apis/ui/interaction/showModal.md | 64 - .../apis/ui/interaction/showToast.md | 49 - .../menu/getMenuButtonBoundingClientRect.md | 31 - .../apis/ui/navigation-bar/hideHomeButton.md | 30 - .../hideNavigationBarLoading.md | 30 - .../navigation-bar/setNavigationBarColor.md | 59 - .../navigation-bar/setNavigationBarTitle.md | 39 - .../showNavigationBarLoading.md | 30 - .../pull-down-refresh/startPullDownRefresh.md | 38 - .../pull-down-refresh/stopPullDownRefresh.md | 38 - .../apis/ui/scroll/ScrollViewContext.md | 89 - .../apis/ui/scroll/pageScrollTo.md | 53 - .../apis/ui/sticky/setTopBarText.md | 42 - .../version-4.x/apis/ui/tab-bar/hideTabBar.md | 31 - .../apis/ui/tab-bar/hideTabBarRedDot.md | 31 - .../apis/ui/tab-bar/removeTabBarBadge.md | 31 - .../apis/ui/tab-bar/setTabBarBadge.md | 41 - .../apis/ui/tab-bar/setTabBarItem.md | 45 - .../apis/ui/tab-bar/setTabBarStyle.md | 45 - .../version-4.x/apis/ui/tab-bar/showTabBar.md | 31 - .../apis/ui/tab-bar/showTabBarRedDot.md | 31 - .../window/checkIsPictureInPictureActive.md | 16 - .../apis/ui/window/offWindowResize.md | 34 - .../apis/ui/window/onWindowResize.md | 47 - .../apis/ui/window/setWindowSize.md | 32 - .../version-4.x/apis/worker/Worker.md | 112 - .../version-4.x/apis/worker/createWorker.md | 35 - .../apis/wxml/IntersectionObserver.md | 179 -- .../apis/wxml/MediaQueryObserver.md | 57 - .../version-4.x/apis/wxml/NodesRef.md | 303 -- .../version-4.x/apis/wxml/SelectorQuery.md | 162 - .../apis/wxml/createIntersectionObserver.md | 39 - .../apis/wxml/createMediaQueryObserver.md | 29 - .../apis/wxml/createSelectorQuery.md | 28 - versioned_docs/version-4.x/app-config.md | 660 ---- versioned_docs/version-4.x/babel-config.md | 241 -- versioned_docs/version-4.x/best-practice.md | 267 -- versioned_docs/version-4.x/children.md | 96 - versioned_docs/version-4.x/cli.md | 180 -- .../version-4.x/codebase-overview.md | 75 - .../version-4.x/come-from-miniapp.mdx | 188 -- versioned_docs/version-4.x/communicate.mdx | 71 - .../version-4.x/compile-optimized.mdx | 70 - versioned_docs/version-4.x/component-style.md | 123 - .../version-4.x/components-desc.mdx | 81 - .../version-4.x/components/base/icon.md | 109 - .../version-4.x/components/base/progress.md | 97 - .../version-4.x/components/base/rich-text.md | 162 - .../version-4.x/components/base/text.md | 143 - .../version-4.x/components/canvas/canvas.md | 97 - .../version-4.x/components/common.md | 134 - .../version-4.x/components/event.md | 12 - .../version-4.x/components/forms/button.md | 409 --- .../components/forms/checkbox-group.md | 92 - .../version-4.x/components/forms/checkbox.md | 176 - .../version-4.x/components/forms/editor.md | 130 - .../version-4.x/components/forms/form.md | 122 - .../version-4.x/components/forms/input.md | 237 -- .../components/forms/keyboard-accessory.md | 45 - .../version-4.x/components/forms/label.md | 80 - .../components/forms/picker-view-column.md | 19 - .../components/forms/picker-view.md | 201 -- .../version-4.x/components/forms/picker.md | 383 --- .../components/forms/radio-group.md | 36 - .../version-4.x/components/forms/radio.md | 195 -- .../version-4.x/components/forms/slider.md | 115 - .../version-4.x/components/forms/switch.md | 99 - .../version-4.x/components/forms/textarea.md | 178 -- .../version-4.x/components/maps/map.md | 495 --- .../components/media/animation-video.md | 44 - .../components/media/animation-view.md | 38 - .../version-4.x/components/media/ar-camera.md | 40 - .../version-4.x/components/media/audio.md | 132 - .../version-4.x/components/media/camera.md | 120 - .../components/media/channel-live.md | 30 - .../components/media/channel-video.md | 42 - .../version-4.x/components/media/image.md | 151 - .../components/media/live-player.md | 204 -- .../components/media/live-pusher.md | 255 -- .../version-4.x/components/media/lottie.md | 58 - .../components/media/rtc-room-item.md | 32 - .../version-4.x/components/media/rtc-room.md | 58 - .../version-4.x/components/media/video.md | 386 --- .../version-4.x/components/media/voip-room.md | 66 - .../navig/functional-page-navigator.md | 58 - .../components/navig/navigation-bar.md | 44 - .../version-4.x/components/navig/navigator.md | 92 - .../version-4.x/components/navig/tab-item.md | 34 - .../version-4.x/components/navig/tabs.md | 42 - .../version-4.x/components/open/ad-custom.md | 52 - .../version-4.x/components/open/ad.md | 145 - .../version-4.x/components/open/aweme-data.md | 38 - .../components/open/comment-detail.md | 52 - .../components/open/comment-list.md | 84 - .../components/open/contact-button.md | 40 - .../components/open/follow-swan.md | 32 - .../components/open/inline-payment-panel.md | 44 - .../version-4.x/components/open/lifestyle.md | 32 - .../version-4.x/components/open/like.md | 62 - .../version-4.x/components/open/login.md | 36 - .../components/open/official-account.md | 64 - .../version-4.x/components/open/open-data.md | 102 - .../version-4.x/components/open/others.md | 18 - .../version-4.x/components/open/web-view.md | 89 - .../version-4.x/components/page-meta.md | 130 - .../components/skyline/grid-view.md | 36 - .../components/skyline/list-view.md | 18 - .../components/skyline/share-element.md | 257 -- .../components/skyline/snapshot.md | 23 - .../components/skyline/sticky-header.md | 18 - .../components/skyline/sticky-section.md | 28 - .../components/viewContainer/cover-image.md | 121 - .../components/viewContainer/cover-view.md | 152 - .../viewContainer/custom-wrapper.md | 36 - .../components/viewContainer/match-media.md | 86 - .../components/viewContainer/movable-area.md | 61 - .../components/viewContainer/movable-view.md | 141 - .../components/viewContainer/native-slot.md | 44 - .../viewContainer/page-container.md | 80 - .../components/viewContainer/root-portal.md | 64 - .../components/viewContainer/scroll-view.md | 338 -- .../components/viewContainer/slot.md | 48 - .../components/viewContainer/swiper-item.md | 97 - .../components/viewContainer/swiper.md | 207 -- .../components/viewContainer/view.md | 150 - versioned_docs/version-4.x/composition-api.md | 287 -- versioned_docs/version-4.x/composition.md | 132 - versioned_docs/version-4.x/condition.md | 111 - versioned_docs/version-4.x/config-detail.md | 2130 ------------ versioned_docs/version-4.x/config.md | 167 - versioned_docs/version-4.x/context.md | 169 - .../version-4.x/convert-to-react.md | 71 - versioned_docs/version-4.x/css-in-js.mdx | 419 --- versioned_docs/version-4.x/css-modules.md | 95 - versioned_docs/version-4.x/custom-tabbar.mdx | 195 -- versioned_docs/version-4.x/debug-config.md | 136 - versioned_docs/version-4.x/debug.md | 287 -- .../version-4.x/difference-to-others.md | 37 - versioned_docs/version-4.x/dynamic-import.md | 103 - versioned_docs/version-4.x/env-mode-config.md | 108 - versioned_docs/version-4.x/envs-debug.md | 23 - versioned_docs/version-4.x/envs.md | 242 -- versioned_docs/version-4.x/event.md | 191 -- .../version-4.x/external-libraries.md | 334 -- versioned_docs/version-4.x/folder.md | 127 - .../version-4.x/functional-component.md | 95 - versioned_docs/version-4.x/guide.mdx | 1739 ---------- versioned_docs/version-4.x/h5.md | 318 -- versioned_docs/version-4.x/harmony.md | 238 -- versioned_docs/version-4.x/hooks.md | 653 ---- versioned_docs/version-4.x/html.mdx | 276 -- versioned_docs/version-4.x/hybrid.mdx | 362 --- versioned_docs/version-4.x/implement-note.md | 110 - .../version-4.x/independent-subpackage.md | 56 - versioned_docs/version-4.x/join-in.md | 82 - versioned_docs/version-4.x/jquery-like.md | 695 ---- versioned_docs/version-4.x/jsx.md | 196 -- versioned_docs/version-4.x/list.md | 196 -- versioned_docs/version-4.x/mdx/image-list.tsx | 27 - versioned_docs/version-4.x/migration.md | 328 -- .../version-4.x/mini-split-chunks-plugin.md | 219 -- .../version-4.x/mini-troubleshooting.md | 18 - .../version-4.x/miniprogram-plugin.md | 183 -- versioned_docs/version-4.x/mobx.md | 345 -- versioned_docs/version-4.x/news.js | 40 - versioned_docs/version-4.x/nutui.mdx | 213 -- versioned_docs/version-4.x/optimized.mdx | 367 --- versioned_docs/version-4.x/ossa.md | 208 -- versioned_docs/version-4.x/page-config.mdx | 125 - versioned_docs/version-4.x/pinia.md | 84 - .../version-4.x/platform-plugin/how.md | 295 -- .../version-4.x/platform-plugin/index.md | 136 - .../platform-plugin/platform-mini.md | 524 --- .../platform-plugin/platform-web.md | 297 -- .../version-4.x/platform-plugin/reconciler.md | 199 -- .../version-4.x/platform-plugin/template.md | 375 --- versioned_docs/version-4.x/plugin-custom.md | 381 --- versioned_docs/version-4.x/plugin-mini-ci.md | 475 --- versioned_docs/version-4.x/plugin.md | 78 - versioned_docs/version-4.x/preact.md | 89 - versioned_docs/version-4.x/prebundle.md | 92 - versioned_docs/version-4.x/prerender.md | 269 -- versioned_docs/version-4.x/project-config.md | 31 - versioned_docs/version-4.x/props.md | 102 - versioned_docs/version-4.x/quick-app.md | 207 -- versioned_docs/version-4.x/react-18.md | 41 - versioned_docs/version-4.x/react-devtools.md | 78 - versioned_docs/version-4.x/react-entry.mdx | 199 -- .../version-4.x/react-error-handling.mdx | 289 -- .../version-4.x/react-native-remind.md | 446 --- versioned_docs/version-4.x/react-native.md | 301 -- versioned_docs/version-4.x/react-overall.md | 247 -- versioned_docs/version-4.x/react-page.mdx | 466 --- versioned_docs/version-4.x/redux.md | 334 -- versioned_docs/version-4.x/ref.mdx | 532 --- versioned_docs/version-4.x/relations.md | 39 - versioned_docs/version-4.x/render-props.md | 84 - versioned_docs/version-4.x/report.md | 29 - versioned_docs/version-4.x/request.md | 67 - versioned_docs/version-4.x/router-extend.mdx | 261 -- versioned_docs/version-4.x/router.mdx | 109 - versioned_docs/version-4.x/seowhy.md | 80 - versioned_docs/version-4.x/size.md | 266 -- versioned_docs/version-4.x/spec-for-taro.md | 42 - versioned_docs/version-4.x/specials.md | 17 - versioned_docs/version-4.x/state.md | 242 -- .../version-4.x/static-reference.md | 82 - versioned_docs/version-4.x/tailwindcss.md | 245 -- versioned_docs/version-4.x/taro-dom.md | 185 -- .../version-4.x/taro-in-miniapp.mdx | 536 ---- .../version-4.x/taro-quickapp-manifest.md | 85 - .../version-4.x/taroize-troubleshooting.md | 287 -- versioned_docs/version-4.x/taroize.md | 29 - versioned_docs/version-4.x/team/58anjuke.md | 56 - .../version-4.x/team/components.tsx | 71 - versioned_docs/version-4.x/team/index.mdx | 185 -- .../version-4.x/team/role-collaborator.mdx | 17 - .../version-4.x/team/role-committee.mdx | 17 - .../version-4.x/team/role-committer.mdx | 17 - .../version-4.x/team/role-triage.mdx | 17 - .../version-4.x/team/team-community.mdx | 17 - versioned_docs/version-4.x/team/team-core.mdx | 27 - .../version-4.x/team/team-innovate.mdx | 21 - .../version-4.x/team/team-platform.mdx | 31 - .../version-4.x/team/team-plugin.mdx | 25 - versioned_docs/version-4.x/template.md | 275 -- .../version-4.x/test-utils/fire-event.md | 148 - .../version-4.x/test-utils/index.md | 171 - .../version-4.x/test-utils/life-cycle.md | 183 -- .../version-4.x/test-utils/other.md | 51 - .../version-4.x/test-utils/queries.md | 344 -- .../version-4.x/test-utils/render.md | 94 - versioned_docs/version-4.x/treasures.md | 839 ----- versioned_docs/version-4.x/ui-lib.md | 129 - versioned_docs/version-4.x/use-h5.mdx | 430 --- versioned_docs/version-4.x/vant.mdx | 310 -- versioned_docs/version-4.x/version.md | 65 - versioned_docs/version-4.x/virtual-list.mdx | 740 ----- .../version-4.x/virtual-waterfall.mdx | 711 ----- versioned_docs/version-4.x/vue-devtools.md | 78 - versioned_docs/version-4.x/vue-entry.mdx | 181 -- versioned_docs/version-4.x/vue-overall.mdx | 259 -- versioned_docs/version-4.x/vue-page.mdx | 434 --- versioned_docs/version-4.x/vue3.md | 119 - versioned_docs/version-4.x/vuex.md | 81 - versioned_docs/version-4.x/wxcloudbase.md | 45 - versioned_docs/version-4.x/youshu.md | 103 - versioned_sidebars/version-4.x-sidebars.json | 1265 -------- versions.json | 2 +- 774 files changed, 3 insertions(+), 83489 deletions(-) delete mode 100644 versioned_docs/version-4.x/CONTRIBUTING-GUIDE.md delete mode 100644 versioned_docs/version-4.x/CONTRIBUTING.md delete mode 100644 versioned_docs/version-4.x/GETTING-STARTED.mdx delete mode 100644 versioned_docs/version-4.x/README.mdx delete mode 100644 versioned_docs/version-4.x/apis/General.md delete mode 100644 versioned_docs/version-4.x/apis/about/desc.md delete mode 100644 versioned_docs/version-4.x/apis/about/env.md delete mode 100644 versioned_docs/version-4.x/apis/about/events.md delete mode 100644 versioned_docs/version-4.x/apis/about/tarocomponent.md delete mode 100644 versioned_docs/version-4.x/apis/ad/InterstitialAd.md delete mode 100644 versioned_docs/version-4.x/apis/ad/RewardedVideoAd.md delete mode 100644 versioned_docs/version-4.x/apis/ad/createInterstitialAd.md delete mode 100644 versioned_docs/version-4.x/apis/ad/createRewardedVideoAd.md delete mode 100644 versioned_docs/version-4.x/apis/ai/face/faceDetect.md delete mode 100644 versioned_docs/version-4.x/apis/ai/face/initFaceDetect.md delete mode 100644 versioned_docs/version-4.x/apis/ai/face/stopFaceDetect.md delete mode 100644 versioned_docs/version-4.x/apis/ai/inference/InferenceSession.md delete mode 100644 versioned_docs/version-4.x/apis/ai/inference/createInferenceSession.md delete mode 100644 versioned_docs/version-4.x/apis/ai/inference/getInferenceEnvInfo.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKBodyAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKCamera.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKDepthAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKFaceAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKFrame.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKHandAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKMarkerAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKOCRAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKOSDAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKPlaneAnchor.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/VKSession.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/createVKSession.md delete mode 100644 versioned_docs/version-4.x/apis/ai/visionkit/isVKSupport.md delete mode 100644 versioned_docs/version-4.x/apis/alipay/getOpenUserInfo.md delete mode 100644 versioned_docs/version-4.x/apis/alipay/tradePay.md delete mode 100644 versioned_docs/version-4.x/apis/base/arrayBufferToBase64.md delete mode 100644 versioned_docs/version-4.x/apis/base/base64ToArrayBuffer.md delete mode 100644 versioned_docs/version-4.x/apis/base/canIUse.md delete mode 100644 versioned_docs/version-4.x/apis/base/canIUseWebp.md delete mode 100644 versioned_docs/version-4.x/apis/base/crypto/UserCryptoManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/crypto/getRandomValues.md delete mode 100644 versioned_docs/version-4.x/apis/base/crypto/getUserCryptoManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/LogManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/RealtimeLogManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/RealtimeTagLogManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/console.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/getLogManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/getRealtimeLogManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/debug/setEnableDebug.md delete mode 100644 versioned_docs/version-4.x/apis/base/env.md delete mode 100644 versioned_docs/version-4.x/apis/base/env/env.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/EntryList.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/Performance.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/PerformanceEntry.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/PerformanceObserver.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/getPerformance.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/preloadAssets.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/preloadSkylineView.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/preloadWebview.md delete mode 100644 versioned_docs/version-4.x/apis/base/performance/reportPerformance.md delete mode 100644 versioned_docs/version-4.x/apis/base/preload.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getAppAuthorizeSetting.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getAppBaseInfo.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getDeviceInfo.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getRendererUserAgent.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSkylineInfo.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSkylineInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSystemInfo.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSystemInfoAsync.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSystemInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getSystemSetting.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/getWindowInfo.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/openAppAuthorizeSetting.md delete mode 100644 versioned_docs/version-4.x/apis/base/system/openSystemBluetoothSetting.md delete mode 100644 versioned_docs/version-4.x/apis/base/update/UpdateManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/update/getUpdateManager.md delete mode 100644 versioned_docs/version-4.x/apis/base/update/updateWeChatApp.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offAppHide.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offAppShow.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionBegin.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionEnd.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offError.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offPageNotFound.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offThemeChange.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/offUnhandledRejection.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onAppHide.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onAppShow.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionBegin.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionEnd.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onError.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onPageNotFound.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onThemeChange.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/app-event/onUnhandledRejection.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/life-cycle/getEnterOptionsSync.md delete mode 100644 versioned_docs/version-4.x/apis/base/weapp/life-cycle/getLaunchOptionsSync.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/Canvas.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/CanvasContext.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/CanvasGradient.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/Color.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/Image.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/ImageData.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/OffscreenCanvas.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/Path2D.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/RenderingContext.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/canvasGetImageData.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/canvasPutImageData.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/canvasToTempFilePath.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/createCanvasContext.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/createContext.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/createOffscreenCanvas.md delete mode 100644 versioned_docs/version-4.x/apis/canvas/drawCanvas.md delete mode 100644 versioned_docs/version-4.x/apis/cloud/DB.md delete mode 100644 versioned_docs/version-4.x/apis/cloud/cloud.md delete mode 100644 versioned_docs/version-4.x/apis/data-analysis/getCommonConfig.md delete mode 100644 versioned_docs/version-4.x/apis/data-analysis/getExptInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/data-analysis/reportAnalytics.md delete mode 100644 versioned_docs/version-4.x/apis/data-analysis/reportEvent.md delete mode 100644 versioned_docs/version-4.x/apis/data-analysis/reportMonitor.md delete mode 100644 versioned_docs/version-4.x/apis/device/accelerometer/offAccelerometerChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/accelerometer/onAccelerometerChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/accelerometer/startAccelerometer.md delete mode 100644 versioned_docs/version-4.x/apis/device/accelerometer/stopAccelerometer.md delete mode 100644 versioned_docs/version-4.x/apis/device/accessibility/checkIsOpenAccessibility.md delete mode 100644 versioned_docs/version-4.x/apis/device/battery/getBatteryInfo.md delete mode 100644 versioned_docs/version-4.x/apis/device/battery/getBatteryInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/closeBLEConnection.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/createBLEConnection.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceCharacteristics.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceRSSI.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceServices.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEMTU.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/notifyBLECharacteristicValueChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLECharacteristicValueChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEConnectionStateChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEMTUChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLECharacteristicValueChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEConnectionStateChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEMTUChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/readBLECharacteristicValue.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/setBLEMTU.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-ble/writeBLECharacteristicValue.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-peripheral/BLEPeripheralServer.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-peripheral/createBLEPeripheralServer.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-peripheral/offBLEPeripheralConnectionStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth-peripheral/onBLEPeripheralConnectionStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/closeBluetoothAdapter.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothAdapterState.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothDevices.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/getConnectedBluetoothDevices.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/isBluetoothDevicePaired.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/makeBluetoothPair.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothAdapterStateChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothDeviceFound.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothAdapterStateChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothDeviceFound.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/openBluetoothAdapter.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/startBluetoothDevicesDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/device/bluetooth/stopBluetoothDevicesDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/device/calendar/addPhoneCalendar.md delete mode 100644 versioned_docs/version-4.x/apis/device/calendar/addPhoneRepeatCalendar.md delete mode 100644 versioned_docs/version-4.x/apis/device/clipboard/getClipboardData.md delete mode 100644 versioned_docs/version-4.x/apis/device/clipboard/setClipboardData.md delete mode 100644 versioned_docs/version-4.x/apis/device/compass/offCompassChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/compass/onCompassChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/compass/startCompass.md delete mode 100644 versioned_docs/version-4.x/apis/device/compass/stopCompass.md delete mode 100644 versioned_docs/version-4.x/apis/device/contact/addPhoneContact.md delete mode 100644 versioned_docs/version-4.x/apis/device/contact/chooseContact.md delete mode 100644 versioned_docs/version-4.x/apis/device/gyroscope/offGyroscopeChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/gyroscope/onGyroscopeChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/gyroscope/startGyroscope.md delete mode 100644 versioned_docs/version-4.x/apis/device/gyroscope/stopGyroscope.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/IBeaconInfo.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/getBeacons.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/offBeaconServiceChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/offBeaconUpdate.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/onBeaconServiceChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/onBeaconUpdate.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/startBeaconDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/device/iBeacon/stopBeaconDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/device/keyboard/getSelectedTextRange.md delete mode 100644 versioned_docs/version-4.x/apis/device/keyboard/hideKeyboard.md delete mode 100644 versioned_docs/version-4.x/apis/device/keyboard/offKeyboardHeightChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/keyboard/onKeyboardHeightChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/memory/offMemoryWarning.md delete mode 100644 versioned_docs/version-4.x/apis/device/memory/onMemoryWarning.md delete mode 100644 versioned_docs/version-4.x/apis/device/motion/offDeviceMotionChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/motion/onDeviceMotionChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/motion/startDeviceMotionListening.md delete mode 100644 versioned_docs/version-4.x/apis/device/motion/stopDeviceMotionListening.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/getLocalIPAddress.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/getNetworkType.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/offNetworkStatusChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/offNetworkWeakChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/onNetworkStatusChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/network/onNetworkWeakChange.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/IsoDep.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/MifareClassic.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/MifareUltralight.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/NFCAdapter.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/Ndef.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/NfcA.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/NfcB.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/NfcF.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/NfcV.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/getHCEState.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/getNFCAdapter.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/offHCEMessage.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/onHCEMessage.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/sendHCEMessage.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/startHCE.md delete mode 100644 versioned_docs/version-4.x/apis/device/nfc/stopHCE.md delete mode 100644 versioned_docs/version-4.x/apis/device/phone/makePhoneCall.md delete mode 100644 versioned_docs/version-4.x/apis/device/scan/scanCode.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/getScreenBrightness.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/getScreenRecordingState.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/offScreenRecordingStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/offUserCaptureScreen.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/onScreenRecordingStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/onUserCaptureScreen.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/setKeepScreenOn.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/setScreenBrightness.md delete mode 100644 versioned_docs/version-4.x/apis/device/screen/setVisualEffectOnCapture.md delete mode 100644 versioned_docs/version-4.x/apis/device/sms/sendSms.md delete mode 100644 versioned_docs/version-4.x/apis/device/vibrate/vibrateLong.md delete mode 100644 versioned_docs/version-4.x/apis/device/vibrate/vibrateShort.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/WifiInfo.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/connectWifi.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/getConnectedWifi.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/getWifiList.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/offGetWifiList.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/offWifiConnected.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/offWifiConnectedWithPartialInfo.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/onGetWifiList.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/onWifiConnected.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/onWifiConnectedWithPartialInfo.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/setWifiList.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/startWifi.md delete mode 100644 versioned_docs/version-4.x/apis/device/wifi/stopWifi.md delete mode 100644 versioned_docs/version-4.x/apis/ext/getExtConfig.md delete mode 100644 versioned_docs/version-4.x/apis/ext/getExtConfigSync.md delete mode 100644 versioned_docs/version-4.x/apis/files/FileSystemManager.md delete mode 100644 versioned_docs/version-4.x/apis/files/ReadResult.md delete mode 100644 versioned_docs/version-4.x/apis/files/Stats.md delete mode 100644 versioned_docs/version-4.x/apis/files/WriteResult.md delete mode 100644 versioned_docs/version-4.x/apis/files/getFileInfo.md delete mode 100644 versioned_docs/version-4.x/apis/files/getFileSystemManager.md delete mode 100644 versioned_docs/version-4.x/apis/files/getSavedFileInfo.md delete mode 100644 versioned_docs/version-4.x/apis/files/getSavedFileList.md delete mode 100644 versioned_docs/version-4.x/apis/files/openDocument.md delete mode 100644 versioned_docs/version-4.x/apis/files/removeSavedFile.md delete mode 100644 versioned_docs/version-4.x/apis/files/saveFile.md delete mode 100644 versioned_docs/version-4.x/apis/files/saveFileToDisk.md delete mode 100644 versioned_docs/version-4.x/apis/framework/App.md delete mode 100644 versioned_docs/version-4.x/apis/framework/Page.md delete mode 100644 versioned_docs/version-4.x/apis/framework/getApp.md delete mode 100644 versioned_docs/version-4.x/apis/framework/getCurrentPages.md delete mode 100644 versioned_docs/version-4.x/apis/index.md delete mode 100644 versioned_docs/version-4.x/apis/location/chooseLocation.md delete mode 100644 versioned_docs/version-4.x/apis/location/choosePoi.md delete mode 100644 versioned_docs/version-4.x/apis/location/getFuzzyLocation.md delete mode 100644 versioned_docs/version-4.x/apis/location/getLocation.md delete mode 100644 versioned_docs/version-4.x/apis/location/offLocationChange.md delete mode 100644 versioned_docs/version-4.x/apis/location/offLocationChangeError.md delete mode 100644 versioned_docs/version-4.x/apis/location/onLocationChange.md delete mode 100644 versioned_docs/version-4.x/apis/location/onLocationChangeError.md delete mode 100644 versioned_docs/version-4.x/apis/location/openLocation.md delete mode 100644 versioned_docs/version-4.x/apis/location/startLocationUpdate.md delete mode 100644 versioned_docs/version-4.x/apis/location/startLocationUpdateBackground.md delete mode 100644 versioned_docs/version-4.x/apis/location/stopLocationUpdate.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/AudioBuffer.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/AudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/InnerAudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/MediaAudioPlayer.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/WebAudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/WebAudioContextNode.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/createAudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/createInnerAudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/createMediaAudioPlayer.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/createWebAudioContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/getAvailableAudioSources.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/pauseVoice.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/playVoice.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/setInnerAudioOption.md delete mode 100644 versioned_docs/version-4.x/apis/media/audio/stopVoice.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/BackgroundAudioManager.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioManager.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioPlayerState.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPause.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPlay.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioStop.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/pauseBackgroundAudio.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/playBackgroundAudio.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/seekBackgroundAudio.md delete mode 100644 versioned_docs/version-4.x/apis/media/background-audio/stopBackgroundAudio.md delete mode 100644 versioned_docs/version-4.x/apis/media/camera/CameraContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/camera/CameraFrameListener.md delete mode 100644 versioned_docs/version-4.x/apis/media/camera/createCameraContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/editor/EditorContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/chooseImage.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/chooseMessageFile.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/compressImage.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/cropImage.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/editImage.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/getImageInfo.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/previewImage.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/previewMedia.md delete mode 100644 versioned_docs/version-4.x/apis/media/image/saveImageToPhotosAlbum.md delete mode 100644 versioned_docs/version-4.x/apis/media/live/LivePlayerContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/live/LivePusherContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/live/createLivePlayerContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/live/createLivePusherContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/map/MapContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/map/createMapContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/media-recorder/MediaRecorder.md delete mode 100644 versioned_docs/version-4.x/apis/media/media-recorder/createMediaRecorder.md delete mode 100644 versioned_docs/version-4.x/apis/media/recorder/RecorderManager.md delete mode 100644 versioned_docs/version-4.x/apis/media/recorder/getRecorderManager.md delete mode 100644 versioned_docs/version-4.x/apis/media/recorder/startRecord.md delete mode 100644 versioned_docs/version-4.x/apis/media/recorder/stopRecord.md delete mode 100644 versioned_docs/version-4.x/apis/media/video-decoder/VideoDecoder.md delete mode 100644 versioned_docs/version-4.x/apis/media/video-decoder/createVideoDecoder.md delete mode 100644 versioned_docs/version-4.x/apis/media/video-processing/MediaContainer.md delete mode 100644 versioned_docs/version-4.x/apis/media/video-processing/MediaTrack.md delete mode 100644 versioned_docs/version-4.x/apis/media/video-processing/createMediaContainer.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/VideoContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/chooseMedia.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/chooseVideo.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/compressVideo.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/createVideoContext.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/getVideoInfo.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/openVideoEditor.md delete mode 100644 versioned_docs/version-4.x/apis/media/video/saveVideoToPhotosAlbum.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/exitVoIPChat.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/join1v1Chat.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/joinVoIPChat.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/offVoIPChatInterrupted.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/offVoIPChatMembersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/offVoIPChatSpeakersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/offVoIPChatStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/offVoIPVideoMembersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/onVoIPChatInterrupted.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/onVoIPChatMembersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/onVoIPChatSpeakersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/onVoIPChatStateChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/onVoIPVideoMembersChanged.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/setEnable1v1Chat.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/subscribeVoIPVideoMembers.md delete mode 100644 versioned_docs/version-4.x/apis/media/voip/updateVoIPChatMuteConfig.md delete mode 100644 versioned_docs/version-4.x/apis/navigate/exitMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/navigate/navigateBackMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/navigate/navigateToMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/navigate/openBusinessView.md delete mode 100644 versioned_docs/version-4.x/apis/navigate/openEmbeddedMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/network/download/DownloadTask.md delete mode 100644 versioned_docs/version-4.x/apis/network/download/downloadFile.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/offLocalServiceDiscoveryStop.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/offLocalServiceFound.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/offLocalServiceLost.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/offLocalServiceResolveFail.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/onLocalServiceDiscoveryStop.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/onLocalServiceFound.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/onLocalServiceLost.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/onLocalServiceResolveFail.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/startLocalServiceDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/network/mdns/stopLocalServiceDiscovery.md delete mode 100644 versioned_docs/version-4.x/apis/network/request/RequestTask.md delete mode 100644 versioned_docs/version-4.x/apis/network/request/addInterceptor.md delete mode 100644 versioned_docs/version-4.x/apis/network/request/cleanInterceptors.md delete mode 100644 versioned_docs/version-4.x/apis/network/request/request.md delete mode 100644 versioned_docs/version-4.x/apis/network/tcp/TCPSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/tcp/createTCPSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/udp/UDPSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/udp/createUDPSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/upload/UploadTask.md delete mode 100644 versioned_docs/version-4.x/apis/network/upload/uploadFile.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/SocketTask.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/closeSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/connectSocket.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/onSocketClose.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/onSocketError.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/onSocketMessage.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/onSocketOpen.md delete mode 100644 versioned_docs/version-4.x/apis/network/websocket/sendSocketMessage.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/account/getAccountInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/address/chooseAddress.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/authorize/authorize.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/authorize/authorizeForMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/card/addCard.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/card/card.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/card/openCard.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveInfo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveNoticeInfo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/getChannelsShareKey.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/openChannelsActivity.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/openChannelsEvent.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/openChannelsLive.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/openChannelsUserProfile.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/channels/reserveChannelsLive.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/customer-service/openCustomerServiceChat.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/device-voip/getDeviceVoIPList.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/device-voip/requestDeviceVoIP.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/facial/checkIsSupportFacialRecognition.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerify.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerifyAndUploadVideo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/favorites/addFileToFavorites.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/favorites/addVideoToFavorites.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/group/getGroupEnterInfo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoice.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoiceTitle.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/license-plate/chooseLicensePlate.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/login/checkSession.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/login/login.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/login/pluginLogin.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/my-miniprogram/checkIsAddedToMyMiniProgram.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/privacy/getPrivacySetting.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/privacy/onNeedPrivacyAuthorization.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/privacy/openPrivacyContract.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/privacy/requirePrivacyAuthorize.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/redpackage/showRedPackage.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/settings/AuthSetting.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/settings/SubscriptionsSetting.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/settings/getSetting.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/settings/openSetting.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/soter/checkIsSoterEnrolledInDevice.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/soter/checkIsSupportSoterAuthentication.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/soter/startSoterAuthentication.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeDeviceMessage.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeMessage.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/user-info/UserInfo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/user-info/getUserInfo.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/user-info/getUserProfile.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/werun/getWeRunData.md delete mode 100644 versioned_docs/version-4.x/apis/open-api/werun/shareToWeRun.md delete mode 100644 versioned_docs/version-4.x/apis/payment/faceVerifyForPay.md delete mode 100644 versioned_docs/version-4.x/apis/payment/requestOrderPayment.md delete mode 100644 versioned_docs/version-4.x/apis/payment/requestPayment.md delete mode 100644 versioned_docs/version-4.x/apis/qq/openQzonePublish.md delete mode 100644 versioned_docs/version-4.x/apis/route/EventChannel.md delete mode 100644 versioned_docs/version-4.x/apis/route/navigateBack.md delete mode 100644 versioned_docs/version-4.x/apis/route/navigateTo.md delete mode 100644 versioned_docs/version-4.x/apis/route/reLaunch.md delete mode 100644 versioned_docs/version-4.x/apis/route/redirectTo.md delete mode 100644 versioned_docs/version-4.x/apis/route/switchTab.md delete mode 100644 versioned_docs/version-4.x/apis/share/authPrivateMessage.md delete mode 100644 versioned_docs/version-4.x/apis/share/getShareInfo.md delete mode 100644 versioned_docs/version-4.x/apis/share/hideShareMenu.md delete mode 100644 versioned_docs/version-4.x/apis/share/offCopyUrl.md delete mode 100644 versioned_docs/version-4.x/apis/share/onCopyUrl.md delete mode 100644 versioned_docs/version-4.x/apis/share/shareFileMessage.md delete mode 100644 versioned_docs/version-4.x/apis/share/shareVideoMessage.md delete mode 100644 versioned_docs/version-4.x/apis/share/showShareImageMenu.md delete mode 100644 versioned_docs/version-4.x/apis/share/showShareMenu.md delete mode 100644 versioned_docs/version-4.x/apis/share/updateShareMenu.md delete mode 100644 versioned_docs/version-4.x/apis/skyline/Snapshot.md delete mode 100644 versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchData.md delete mode 100644 versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchToken.md delete mode 100644 versioned_docs/version-4.x/apis/storage/background-fetch/onBackgroundFetchData.md delete mode 100644 versioned_docs/version-4.x/apis/storage/background-fetch/setBackgroundFetchToken.md delete mode 100644 versioned_docs/version-4.x/apis/storage/batchGetStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/batchGetStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/batchSetStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/batchSetStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/cache-manager/CacheManager.md delete mode 100644 versioned_docs/version-4.x/apis/storage/cache-manager/createCacheManager.md delete mode 100644 versioned_docs/version-4.x/apis/storage/clearStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/clearStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/createBufferURL.md delete mode 100644 versioned_docs/version-4.x/apis/storage/getStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/getStorageInfo.md delete mode 100644 versioned_docs/version-4.x/apis/storage/getStorageInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/getStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/removeStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/removeStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/storage/revokeBufferURL.md delete mode 100644 versioned_docs/version-4.x/apis/storage/setStorage.md delete mode 100644 versioned_docs/version-4.x/apis/storage/setStorageSync.md delete mode 100644 versioned_docs/version-4.x/apis/swan/setPageInfo.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/eventCenter.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getAppInfo.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getCurrentInstance.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getEnv.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getEnvInfoSync.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getRenderer.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/getTabBar.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/initPxTransform.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/interceptorify.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/pxTransform.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/requirePlugin.md delete mode 100644 versioned_docs/version-4.x/apis/taro.extend/setGlobalDataPlugin.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useAddToFavorites.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useDidHide.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useDidShow.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useError.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useLaunch.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useLoad.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useOptionMenuClick.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/usePageNotFound.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/usePageScroll.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/usePullDownRefresh.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/usePullIntercept.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useReachBottom.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useReady.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useResize.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useRouter.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useSaveExitState.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useShareAppMessage.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useShareTimeline.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useTabItemTap.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useTitleClick.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useUnhandledRejection.md delete mode 100644 versioned_docs/version-4.x/apis/taro.hooks/useUnload.md delete mode 100644 versioned_docs/version-4.x/apis/ui/animation/Animation.md delete mode 100644 versioned_docs/version-4.x/apis/ui/animation/createAnimation.md delete mode 100644 versioned_docs/version-4.x/apis/ui/background/setBackgroundColor.md delete mode 100644 versioned_docs/version-4.x/apis/ui/background/setBackgroundTextStyle.md delete mode 100644 versioned_docs/version-4.x/apis/ui/custom-component/nextTick.md delete mode 100644 versioned_docs/version-4.x/apis/ui/fonts/loadFontFace.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/disableAlertBeforeUnload.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/enableAlertBeforeUnload.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/hideLoading.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/hideToast.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/showActionSheet.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/showLoading.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/showModal.md delete mode 100644 versioned_docs/version-4.x/apis/ui/interaction/showToast.md delete mode 100644 versioned_docs/version-4.x/apis/ui/menu/getMenuButtonBoundingClientRect.md delete mode 100644 versioned_docs/version-4.x/apis/ui/navigation-bar/hideHomeButton.md delete mode 100644 versioned_docs/version-4.x/apis/ui/navigation-bar/hideNavigationBarLoading.md delete mode 100644 versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarColor.md delete mode 100644 versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarTitle.md delete mode 100644 versioned_docs/version-4.x/apis/ui/navigation-bar/showNavigationBarLoading.md delete mode 100644 versioned_docs/version-4.x/apis/ui/pull-down-refresh/startPullDownRefresh.md delete mode 100644 versioned_docs/version-4.x/apis/ui/pull-down-refresh/stopPullDownRefresh.md delete mode 100644 versioned_docs/version-4.x/apis/ui/scroll/ScrollViewContext.md delete mode 100644 versioned_docs/version-4.x/apis/ui/scroll/pageScrollTo.md delete mode 100644 versioned_docs/version-4.x/apis/ui/sticky/setTopBarText.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBar.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBarRedDot.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/removeTabBarBadge.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarBadge.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarItem.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarStyle.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/showTabBar.md delete mode 100644 versioned_docs/version-4.x/apis/ui/tab-bar/showTabBarRedDot.md delete mode 100644 versioned_docs/version-4.x/apis/ui/window/checkIsPictureInPictureActive.md delete mode 100644 versioned_docs/version-4.x/apis/ui/window/offWindowResize.md delete mode 100644 versioned_docs/version-4.x/apis/ui/window/onWindowResize.md delete mode 100644 versioned_docs/version-4.x/apis/ui/window/setWindowSize.md delete mode 100644 versioned_docs/version-4.x/apis/worker/Worker.md delete mode 100644 versioned_docs/version-4.x/apis/worker/createWorker.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/IntersectionObserver.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/MediaQueryObserver.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/NodesRef.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/SelectorQuery.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/createIntersectionObserver.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/createMediaQueryObserver.md delete mode 100644 versioned_docs/version-4.x/apis/wxml/createSelectorQuery.md delete mode 100644 versioned_docs/version-4.x/app-config.md delete mode 100644 versioned_docs/version-4.x/babel-config.md delete mode 100644 versioned_docs/version-4.x/best-practice.md delete mode 100644 versioned_docs/version-4.x/children.md delete mode 100644 versioned_docs/version-4.x/cli.md delete mode 100644 versioned_docs/version-4.x/codebase-overview.md delete mode 100644 versioned_docs/version-4.x/come-from-miniapp.mdx delete mode 100644 versioned_docs/version-4.x/communicate.mdx delete mode 100644 versioned_docs/version-4.x/compile-optimized.mdx delete mode 100644 versioned_docs/version-4.x/component-style.md delete mode 100644 versioned_docs/version-4.x/components-desc.mdx delete mode 100755 versioned_docs/version-4.x/components/base/icon.md delete mode 100755 versioned_docs/version-4.x/components/base/progress.md delete mode 100755 versioned_docs/version-4.x/components/base/rich-text.md delete mode 100755 versioned_docs/version-4.x/components/base/text.md delete mode 100755 versioned_docs/version-4.x/components/canvas/canvas.md delete mode 100644 versioned_docs/version-4.x/components/common.md delete mode 100644 versioned_docs/version-4.x/components/event.md delete mode 100755 versioned_docs/version-4.x/components/forms/button.md delete mode 100644 versioned_docs/version-4.x/components/forms/checkbox-group.md delete mode 100755 versioned_docs/version-4.x/components/forms/checkbox.md delete mode 100644 versioned_docs/version-4.x/components/forms/editor.md delete mode 100755 versioned_docs/version-4.x/components/forms/form.md delete mode 100755 versioned_docs/version-4.x/components/forms/input.md delete mode 100644 versioned_docs/version-4.x/components/forms/keyboard-accessory.md delete mode 100755 versioned_docs/version-4.x/components/forms/label.md delete mode 100644 versioned_docs/version-4.x/components/forms/picker-view-column.md delete mode 100755 versioned_docs/version-4.x/components/forms/picker-view.md delete mode 100755 versioned_docs/version-4.x/components/forms/picker.md delete mode 100644 versioned_docs/version-4.x/components/forms/radio-group.md delete mode 100755 versioned_docs/version-4.x/components/forms/radio.md delete mode 100755 versioned_docs/version-4.x/components/forms/slider.md delete mode 100755 versioned_docs/version-4.x/components/forms/switch.md delete mode 100755 versioned_docs/version-4.x/components/forms/textarea.md delete mode 100755 versioned_docs/version-4.x/components/maps/map.md delete mode 100644 versioned_docs/version-4.x/components/media/animation-video.md delete mode 100644 versioned_docs/version-4.x/components/media/animation-view.md delete mode 100644 versioned_docs/version-4.x/components/media/ar-camera.md delete mode 100755 versioned_docs/version-4.x/components/media/audio.md delete mode 100755 versioned_docs/version-4.x/components/media/camera.md delete mode 100644 versioned_docs/version-4.x/components/media/channel-live.md delete mode 100644 versioned_docs/version-4.x/components/media/channel-video.md delete mode 100755 versioned_docs/version-4.x/components/media/image.md delete mode 100755 versioned_docs/version-4.x/components/media/live-player.md delete mode 100755 versioned_docs/version-4.x/components/media/live-pusher.md delete mode 100644 versioned_docs/version-4.x/components/media/lottie.md delete mode 100644 versioned_docs/version-4.x/components/media/rtc-room-item.md delete mode 100644 versioned_docs/version-4.x/components/media/rtc-room.md delete mode 100755 versioned_docs/version-4.x/components/media/video.md delete mode 100644 versioned_docs/version-4.x/components/media/voip-room.md delete mode 100644 versioned_docs/version-4.x/components/navig/functional-page-navigator.md delete mode 100644 versioned_docs/version-4.x/components/navig/navigation-bar.md delete mode 100755 versioned_docs/version-4.x/components/navig/navigator.md delete mode 100644 versioned_docs/version-4.x/components/navig/tab-item.md delete mode 100644 versioned_docs/version-4.x/components/navig/tabs.md delete mode 100644 versioned_docs/version-4.x/components/open/ad-custom.md delete mode 100644 versioned_docs/version-4.x/components/open/ad.md delete mode 100644 versioned_docs/version-4.x/components/open/aweme-data.md delete mode 100644 versioned_docs/version-4.x/components/open/comment-detail.md delete mode 100644 versioned_docs/version-4.x/components/open/comment-list.md delete mode 100644 versioned_docs/version-4.x/components/open/contact-button.md delete mode 100644 versioned_docs/version-4.x/components/open/follow-swan.md delete mode 100644 versioned_docs/version-4.x/components/open/inline-payment-panel.md delete mode 100644 versioned_docs/version-4.x/components/open/lifestyle.md delete mode 100644 versioned_docs/version-4.x/components/open/like.md delete mode 100644 versioned_docs/version-4.x/components/open/login.md delete mode 100644 versioned_docs/version-4.x/components/open/official-account.md delete mode 100755 versioned_docs/version-4.x/components/open/open-data.md delete mode 100644 versioned_docs/version-4.x/components/open/others.md delete mode 100755 versioned_docs/version-4.x/components/open/web-view.md delete mode 100644 versioned_docs/version-4.x/components/page-meta.md delete mode 100644 versioned_docs/version-4.x/components/skyline/grid-view.md delete mode 100644 versioned_docs/version-4.x/components/skyline/list-view.md delete mode 100644 versioned_docs/version-4.x/components/skyline/share-element.md delete mode 100644 versioned_docs/version-4.x/components/skyline/snapshot.md delete mode 100644 versioned_docs/version-4.x/components/skyline/sticky-header.md delete mode 100644 versioned_docs/version-4.x/components/skyline/sticky-section.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/cover-image.md delete mode 100755 versioned_docs/version-4.x/components/viewContainer/cover-view.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/custom-wrapper.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/match-media.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/movable-area.md delete mode 100755 versioned_docs/version-4.x/components/viewContainer/movable-view.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/native-slot.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/page-container.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/root-portal.md delete mode 100755 versioned_docs/version-4.x/components/viewContainer/scroll-view.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/slot.md delete mode 100644 versioned_docs/version-4.x/components/viewContainer/swiper-item.md delete mode 100755 versioned_docs/version-4.x/components/viewContainer/swiper.md delete mode 100755 versioned_docs/version-4.x/components/viewContainer/view.md delete mode 100644 versioned_docs/version-4.x/composition-api.md delete mode 100644 versioned_docs/version-4.x/composition.md delete mode 100644 versioned_docs/version-4.x/condition.md delete mode 100644 versioned_docs/version-4.x/config-detail.md delete mode 100644 versioned_docs/version-4.x/config.md delete mode 100644 versioned_docs/version-4.x/context.md delete mode 100644 versioned_docs/version-4.x/convert-to-react.md delete mode 100644 versioned_docs/version-4.x/css-in-js.mdx delete mode 100644 versioned_docs/version-4.x/css-modules.md delete mode 100644 versioned_docs/version-4.x/custom-tabbar.mdx delete mode 100644 versioned_docs/version-4.x/debug-config.md delete mode 100644 versioned_docs/version-4.x/debug.md delete mode 100644 versioned_docs/version-4.x/difference-to-others.md delete mode 100644 versioned_docs/version-4.x/dynamic-import.md delete mode 100644 versioned_docs/version-4.x/env-mode-config.md delete mode 100644 versioned_docs/version-4.x/envs-debug.md delete mode 100644 versioned_docs/version-4.x/envs.md delete mode 100644 versioned_docs/version-4.x/event.md delete mode 100644 versioned_docs/version-4.x/external-libraries.md delete mode 100644 versioned_docs/version-4.x/folder.md delete mode 100644 versioned_docs/version-4.x/functional-component.md delete mode 100644 versioned_docs/version-4.x/guide.mdx delete mode 100644 versioned_docs/version-4.x/h5.md delete mode 100644 versioned_docs/version-4.x/harmony.md delete mode 100644 versioned_docs/version-4.x/hooks.md delete mode 100644 versioned_docs/version-4.x/html.mdx delete mode 100644 versioned_docs/version-4.x/hybrid.mdx delete mode 100644 versioned_docs/version-4.x/implement-note.md delete mode 100644 versioned_docs/version-4.x/independent-subpackage.md delete mode 100644 versioned_docs/version-4.x/join-in.md delete mode 100644 versioned_docs/version-4.x/jquery-like.md delete mode 100644 versioned_docs/version-4.x/jsx.md delete mode 100644 versioned_docs/version-4.x/list.md delete mode 100644 versioned_docs/version-4.x/mdx/image-list.tsx delete mode 100644 versioned_docs/version-4.x/migration.md delete mode 100644 versioned_docs/version-4.x/mini-split-chunks-plugin.md delete mode 100644 versioned_docs/version-4.x/mini-troubleshooting.md delete mode 100644 versioned_docs/version-4.x/miniprogram-plugin.md delete mode 100644 versioned_docs/version-4.x/mobx.md delete mode 100644 versioned_docs/version-4.x/news.js delete mode 100644 versioned_docs/version-4.x/nutui.mdx delete mode 100644 versioned_docs/version-4.x/optimized.mdx delete mode 100644 versioned_docs/version-4.x/ossa.md delete mode 100644 versioned_docs/version-4.x/page-config.mdx delete mode 100644 versioned_docs/version-4.x/pinia.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/how.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/index.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/platform-mini.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/platform-web.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/reconciler.md delete mode 100644 versioned_docs/version-4.x/platform-plugin/template.md delete mode 100644 versioned_docs/version-4.x/plugin-custom.md delete mode 100644 versioned_docs/version-4.x/plugin-mini-ci.md delete mode 100644 versioned_docs/version-4.x/plugin.md delete mode 100644 versioned_docs/version-4.x/preact.md delete mode 100644 versioned_docs/version-4.x/prebundle.md delete mode 100644 versioned_docs/version-4.x/prerender.md delete mode 100644 versioned_docs/version-4.x/project-config.md delete mode 100644 versioned_docs/version-4.x/props.md delete mode 100644 versioned_docs/version-4.x/quick-app.md delete mode 100644 versioned_docs/version-4.x/react-18.md delete mode 100644 versioned_docs/version-4.x/react-devtools.md delete mode 100644 versioned_docs/version-4.x/react-entry.mdx delete mode 100644 versioned_docs/version-4.x/react-error-handling.mdx delete mode 100644 versioned_docs/version-4.x/react-native-remind.md delete mode 100644 versioned_docs/version-4.x/react-native.md delete mode 100644 versioned_docs/version-4.x/react-overall.md delete mode 100644 versioned_docs/version-4.x/react-page.mdx delete mode 100644 versioned_docs/version-4.x/redux.md delete mode 100644 versioned_docs/version-4.x/ref.mdx delete mode 100644 versioned_docs/version-4.x/relations.md delete mode 100644 versioned_docs/version-4.x/render-props.md delete mode 100644 versioned_docs/version-4.x/report.md delete mode 100644 versioned_docs/version-4.x/request.md delete mode 100644 versioned_docs/version-4.x/router-extend.mdx delete mode 100644 versioned_docs/version-4.x/router.mdx delete mode 100644 versioned_docs/version-4.x/seowhy.md delete mode 100644 versioned_docs/version-4.x/size.md delete mode 100644 versioned_docs/version-4.x/spec-for-taro.md delete mode 100644 versioned_docs/version-4.x/specials.md delete mode 100644 versioned_docs/version-4.x/state.md delete mode 100644 versioned_docs/version-4.x/static-reference.md delete mode 100644 versioned_docs/version-4.x/tailwindcss.md delete mode 100644 versioned_docs/version-4.x/taro-dom.md delete mode 100644 versioned_docs/version-4.x/taro-in-miniapp.mdx delete mode 100644 versioned_docs/version-4.x/taro-quickapp-manifest.md delete mode 100644 versioned_docs/version-4.x/taroize-troubleshooting.md delete mode 100644 versioned_docs/version-4.x/taroize.md delete mode 100644 versioned_docs/version-4.x/team/58anjuke.md delete mode 100644 versioned_docs/version-4.x/team/components.tsx delete mode 100644 versioned_docs/version-4.x/team/index.mdx delete mode 100644 versioned_docs/version-4.x/team/role-collaborator.mdx delete mode 100644 versioned_docs/version-4.x/team/role-committee.mdx delete mode 100644 versioned_docs/version-4.x/team/role-committer.mdx delete mode 100644 versioned_docs/version-4.x/team/role-triage.mdx delete mode 100644 versioned_docs/version-4.x/team/team-community.mdx delete mode 100644 versioned_docs/version-4.x/team/team-core.mdx delete mode 100644 versioned_docs/version-4.x/team/team-innovate.mdx delete mode 100644 versioned_docs/version-4.x/team/team-platform.mdx delete mode 100644 versioned_docs/version-4.x/team/team-plugin.mdx delete mode 100644 versioned_docs/version-4.x/template.md delete mode 100644 versioned_docs/version-4.x/test-utils/fire-event.md delete mode 100644 versioned_docs/version-4.x/test-utils/index.md delete mode 100644 versioned_docs/version-4.x/test-utils/life-cycle.md delete mode 100644 versioned_docs/version-4.x/test-utils/other.md delete mode 100644 versioned_docs/version-4.x/test-utils/queries.md delete mode 100644 versioned_docs/version-4.x/test-utils/render.md delete mode 100644 versioned_docs/version-4.x/treasures.md delete mode 100644 versioned_docs/version-4.x/ui-lib.md delete mode 100644 versioned_docs/version-4.x/use-h5.mdx delete mode 100644 versioned_docs/version-4.x/vant.mdx delete mode 100644 versioned_docs/version-4.x/version.md delete mode 100644 versioned_docs/version-4.x/virtual-list.mdx delete mode 100644 versioned_docs/version-4.x/virtual-waterfall.mdx delete mode 100644 versioned_docs/version-4.x/vue-devtools.md delete mode 100644 versioned_docs/version-4.x/vue-entry.mdx delete mode 100644 versioned_docs/version-4.x/vue-overall.mdx delete mode 100644 versioned_docs/version-4.x/vue-page.mdx delete mode 100644 versioned_docs/version-4.x/vue3.md delete mode 100644 versioned_docs/version-4.x/vuex.md delete mode 100644 versioned_docs/version-4.x/wxcloudbase.md delete mode 100644 versioned_docs/version-4.x/youshu.md delete mode 100644 versioned_sidebars/version-4.x-sidebars.json diff --git a/docusaurus.config.js b/docusaurus.config.js index 90dba0485d4a..64fd9a75da18 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -77,7 +77,7 @@ const siteConfig = { lastVersion: '3.x', versions: { current: { - label: '下个版本', + label: '4.x', } } }, diff --git a/src/pages/versions.js b/src/pages/versions.js index 760862266384..58d65ece1769 100644 --- a/src/pages/versions.js +++ b/src/pages/versions.js @@ -54,7 +54,7 @@ function Version () { - +
Latest4.x 文档 diff --git a/versioned_docs/version-4.x/CONTRIBUTING-GUIDE.md b/versioned_docs/version-4.x/CONTRIBUTING-GUIDE.md deleted file mode 100644 index fd8167dc4260..000000000000 --- a/versioned_docs/version-4.x/CONTRIBUTING-GUIDE.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -title: 贡献指南 ---- - -## 贡献代码 - -### 1. 环境准备 - -:::note -需要安装 [Node.js 16](https://nodejs.org/en/)（建议安装 `16.20.0` 及以上版本）及 [pnpm 7](https://pnpm.io/zh/installation) - -各版本 pnpm 与各版本 Node.js 之间的支持情况见 [pnpm 兼容性](https://pnpm.io/zh/installation#%E5%85%BC%E5%AE%B9%E6%80%A7) -::: - -首先把 Taro 仓库 fork 一份到自己的 Github，然后从个人仓库把项目 clone 到本地，项目默认是 `main` 分支。 - -然后依次在项目根目录运行以下命令： - -```bash -# 安装依赖 -$ pnpm i -# 编译构建 -$ pnpm build -``` - -运行完上述命令后，环境已经准备好，此时可以新拉一条分支进行开发。 - -### 2. 开发与调试 - -Taro 由一系列子 npm 包组成，整体项目组织基于 **pnpm workspace**。 - -开发者可以单独修改、编译某个子包： - -```bash -# 编译某个子包，[package-name] 为该子包的 package.json 里的 name 字段 -$ pnpm --filter [package-name] run dev -``` - -开发过程中，一般会使用 **link** 的方式把需要调试的包软链到一个测试项目中，然后便可进行断点调试。开发者可以根据测试项目的包管理器以及自己的喜好选择使用 [npm link](https://docs.npmjs.com/cli/v7/commands/npm-link) 或 [yarn link](https://yarnpkg.com/cli/link)（推荐）或 [pnpm link](https://pnpm.io/zh/cli/link) 。 - -**使用 `yarn link` 的具体示例如下：** - -1. 进入需要调试的子包的根目录，然后执行 `yarn link`。 -2. 进入测试项目的根目录，然后执行 `yarn link`。（注意被调试的子包的版本要和测试项目中该依赖的版本保持一致） - -**使用 `pnpm link` 的具体示例如下：** - -情况一、测试项目 `package.json` 中有声明对该包的依赖 - -1. 进入需要调试的子包的根目录，然后执行 `pnpm link --global`。 -2. 进入测试项目的根目录，然后执行 `pnpm link --global [package-name]`。 - -情况二、测试项目 `package.json` 中没有声明对该包的依赖，该依赖包是被某个 Taro 包间接依赖的，如 `@tarojs/runner-utils`。 - -1. 测试项目的 `package.json` 中新增 pnpm 配置并配置该依赖包的具体链接路径 - -```json -"pnpm": { - "overrides": { - "@tarojs/runner-utils": "/Users/.../taro/packages/taro-runner-utils" - } -}, -``` - -2. 执行 `pnpm i` 重新安装测试项目的依赖 - -在测试项目中创建好链接后，接下来就可以启动项目编译。注意如果是编译 H5 或小程序时，请提前关闭依赖预编译配置： - -```json -// /demo/config/dev.js -compiler: { - type: "webpack5", - prebundle: { - enable: false, - } -} -``` - -接下来在需要被调试的包中加入断点，**运行时代码**可以在各端的开发工具（小程序开发者工具、Chrome...）中断点调试，而**编译时**的代码需要使用 VSCode debugger 进行断点调试，请参考 [《单步调测》](./debug-config)。 - -### 3. 新增/删除依赖 - -推荐遵循的依赖治理规范： - -- 尽量把子包用到的 `dependencies` 和 `devDependencies` 安装在子包。 -- TypeScript、各种 Lint 工具、Rollup 等用于治理 Taro 项目的依赖推荐安装在主包。 -- 如果子包是插件类项目，使用 `peerDependencies` 声明实际项目中肯定会安装的依赖。 - -```bash -# 在根目录新增依赖 -$ pnpm add -wD -# 在根目录删除依赖 -$ pnpm remove -wD -# 为某个子包（如 @tarojs/cli）新增一个依赖 -$ pnpm --filter @tarojs/cli add -# 为某个子包（如 @tarojs/cli）删除一个依赖 -$ pnpm --filter @tarojs/cli remove -# 为所有子包新增一个依赖 -$ pnpm -r --filter=./packages/* add -# 为所有子包删除一个依赖 -$ pnpm -r --filter=./packages/* remove -# 删除根目录的 node_modules 和所有 workspace 里的 node_modules -$ npm run clear-all -``` - -### 4. 单元测试 - -`package.json` 中设置了 `test:ci` 命令的子包都配备了单元测试。 - -开发者在修改这些包后，请运行 `pnpm --filter [package-name] run test:ci`，检查测试用例是否都能通过。 - -同时，在开发一些重要功能后，也请抽时间补上对应的测试用例。 - -**注意：** - -`@tarojs/mini-runner`、`@tarojs/webpack-runner`、`@tarojs/webpack5-runner` 使用了 `snapshot`（测试结果快照）。在修改这两个包或其它一些包时，有可能导致这些快照失效，从而通过不了测试。当你修改了这两个包、或 Github CI 提示这些包的测试用例出错时，请运行 `pnpm --filter [package-name] runupdateSnapshot` 更新 snapshot 后重新提交。 - -### 5. 代码风格 - -- `JavaScript`：JavaScript 风格遵从 [JavaScript Standard Style](https://github.com/standard/standard)。 -- `TypeScript`：TypeScript 风格也是 [JavaScript Standard Style](https://github.com/standard/standard) 的变种，详情请看相关包目录下的 `eslint.json` 和 `tsconfig.json`。 -- 样式：遵循相关包目录下的 `.stylelintrc` 风格。 - -### 6. 提交 commit - -整个 Taro 仓库遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)，在输入 commit message 的时候请务必遵从此规范。 - -### 7.提交 Pull Request - -> 如果对 PR（Pull Request）不了解，请阅读 [《About Pull Requests》](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) - -完成开发后，推送到自己的 Taro 仓库，就可以准备提交 Pull Request 了。 - -提交 PR 前请阅读以下注意事项： - -1. 保证 `npm run build` 能够编译成功。 -2. 保证代码能通过 ESLint 测试。 -3. 当相关包含有 `npm test:ci` 命令时，必须保证所有测试用例都能够通过； -4. 当相关包有测试用例时，请给你提交的代码也添加相应的测试用例； -5. 保证 commit 信息需要遵循 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)。 -6. 如果提交到代码非常多或功能复杂，可以把 PR 分成几个 commit 一起提交。我们在合并时会会根据情况 squash。 -7. PR 作者可以选择加入到 Taro 开发者微信群，方便合并 PR 和技术交流。 - -### 8. 发布测试版本 - -提交 PR 后，开发者可以在开发分支上发布测试版本到 npm。部分难以在本地验证的功能可以使用这种方式进行验证。 - -1. 确保分支名以 `feat/` 或 `chore/` 开头。 -2. 在 Taro 项目根目录执行命令： - -```bash -# 更新 workspace 内所有子包的版本号，如 pnpm version 3.6.22-alpha.0 -$ pnpm version -``` - -3. 执行 `git commit --amend` 命令，手动修改最新一个 commit 的 commit message，加上 `--tag=`（此 tag 代表发布的 npm tag）。如发布 alpha 版本：`chore(release): publish 3.6.22-alpha.0 --tag=alpha`。 -4. 提交修改到远程仓库，将会触发 Github CI 的发布流程。 - -### 9. 文档 - -当提交涉及新增特性、Breaking Changes 或重要修改时，请及时新增、修改对应的文档。 - -关于文档的开发请阅读下一章节：《贡献文档》。 - -### 10. Rust 部分 - -Taro 仓库里有部分使用 Rust 开发的子包，在开发、调试、测试这些包时有不一样的流程。 - -Rust 代码存放在 `crates` 文件夹下，使用 Cargo workspace 管理，目前包括 NAPI bindings 和若干 SWC 插件。 - -开发前请使用 `rustup` 安装 Rust 工具链。 - -#### NAPI bindings - -在根目录执行 `pnpm build:binding:debug` 或 `pnpm build:binding:release` 命令，会在 `crates/native-binding` 文件夹中编译出 binding 文件 `taro.[os-platform].node`。 - -然后可以执行单元测试： - -```bash -$ pnpm --filter @tarojs/binding run test -``` - -或结合调用方执行集成测试。 - -#### SWC 插件 - -首先在项目根目录执行 `rustup target add wasm32-wasi` 命令安装 `wasm32-wasi` 的 `target`。 - -开发过程中可以使用 SWC 测试套件进行单元测试： - -```bash -# 执行所有 SWC 插件的单元测试 -$ cargo test-swc-plugins -# 执行某个 SWC 插件的单元测试 -$ cargo test -p [package-name] -``` - -功能完成后可以编译出 `.wasm` 文件，联合调用方进行集成测试： - -```bash -# 编译所有 SWC 插件 -$ cargo build-swc-plugins -# 编译某个 SWC 插件 -$ cargo build -p [package-name] -``` - -Cargo workspace 会把编译产物输出到根目录的 `target` 文件夹中。进行集成测试时，需要手动把 `.wasm` 产物软链到目标文件夹，而 Github CI 在正式发布时会自动拷贝产物到正确的文件夹中。 - -如对 `@taorjs/helper` 进行集成测试时，会把 `target/wasm32-wasi/release/swc_plugin_xxx.wasm` 文件的软链到 `packages/taro-helper/swc/swc_plugin_xxx.wasm`。 - -## 贡献文档 - -当阅读时遇到明显的错误，开发者可以点击每篇文档最下方的 `Edit this page` 按钮，即会打开 Github 的编辑界面。开发者对文档进行编辑后，就可以提交一个 Pull Request。 - -如果是较复杂的修改，可以按以下步骤进行操作： - -#### 1. fork & clone - -1. fork [taro-docs](https://github.com/NervJS/taro-docs) 仓库 -2. clone 个人仓库的 taro-docs 至本地： - -```bash -git clone https://github.com/{your github name}/taro-docs.git -``` - -#### 2. 编译预览 - -```bash -$ pnpm install -$ pnpm run start -``` - -#### 3. 修改、新增对应文档 - -> 文档支持 `md` 和 `mdx` 后缀，语法详见 [Docusaurus 官网](https://docusaurus.io/docs/next/markdown-features) - -1. 修改文档 - -进入 `docs` 目录，找到对应的文件进行编辑。（必须，对应**下个版本**的相关文档） - -进入 `versioned_docs/version-3.x` 目录，找到对应的文件进行编辑。（可选，对应**3.x 版本**的相关文档。不修改则需要等待 Taro 团队更新文档版本后，才会同步到文档的 `3.x` 版本） - -2. 新增文档 - -新增文档和修改文档类似，首先分别到 `docs` 和 `versioned_docs/version-3.x` 目录新增一个文件。然后在 `sidebars.js` 和 `versioned_sidebars/version-3.x-sidebars.json` 文件中添加上述新增文件的路径。 - -#### 4. 提交 Pull Request diff --git a/versioned_docs/version-4.x/CONTRIBUTING.md b/versioned_docs/version-4.x/CONTRIBUTING.md deleted file mode 100644 index 8727a8b91b93..000000000000 --- a/versioned_docs/version-4.x/CONTRIBUTING.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: 贡献形式 ---- - -正如我们在[《给开发者的信》](./join-in) 中所写的，我们非常欢迎各位开发者为 Taro 社区做出贡献。 - -贡献之前，请你花一些时间阅读以下内容，保证贡献是符合规范并且能帮助到社区。 - -> “Taro 社区如何运作？我可以怎样参与？” - -Taro 接受各种形式的贡献，无论是提交一个重大改动，还是反馈一个问题或参加一次讨论，都能强化 Taro 的网络效应，让 Taro 变得越来越好用。 - -接下来，我们整理了 Taro 社区日常运营中常遇的各种细分情景。开发者可以从“参与讨论”、“提出问题”开始，一步一步融入社区，和 Taro 互相成就、共同成长。 - -### 参与讨论 - -可以到 [Taro 论坛](https://github.com/NervJS/taro/discussions) 的对应板块参与讨论。 - -Taro Github 上不断地产生着 [Issues](https://github.com/NervJS/taro/issues) 和 [Pull Request](https://github.com/NervJS/taro/pulls)，也非常欢迎各位开发者 Review 并参与讨论。 - -### Bug 反馈 - -请使用 [Issue 生成工具](https://issue.taro.zone/) 提交 Bug 反馈，并在上尽可能详细地提供一切必要信息，最好能附上一个可复现的 Demo。 - -一般情况下，**信息提供得越完整，响应时间越短**。 - -### Feature Request - -如果你有一个 Feature Request，请到[论坛](https://github.com/NervJS/taro/discussions/categories/feature-request)新建一条帖子进行描述。 - -Taro 会收集重要的 Feature Requests，在 [《来为 Taro 的 Feature Request 投票吧！》](https://github.com/NervJS/taro/issues/6997) 中进行公示，开发者可以根据需要进行投票，需求强烈的特性会被**优先支持**。 - -### 修改文档 - -文档是开发者与框架沟通的桥梁，但文档一直以来是 Taro 的弱项。一方面我们会不断完善文档，另一方面也希望社区能协助我们把文档做好。 - -在修改之前请先阅读[《贡献指南》](./CONTRIBUTING-GUIDE#贡献文档)，它介绍了 Taro 文档的仓库地址、如何修改等信息。 - -### 新想法 - -无论是 Taro 团队内部还是社区第三方开发者，在为 Taro 提交一个重大特性时，都必须按照 Taro 的 [RFC（Request For Comment）机制](https://github.com/NervJS/taro-rfcs) 进行操作，经过社区讨论完善后再进行代码的提交。 - -因此如果你对 Taro 的发展有新的想法，如实现一个重要功能、拓展新的使用场景等，需要先撰写对应功能的 **RFC** 文档，Taro 团队会进行一系列推送，在社区征集意见。 - -> 可以访问 [taro-rfcs 仓库](https://github.com/NervJS/taro-rfcs)提交 RFC 或者查看相关的 RFC。 - -### 提交代码 - -> “我可以从哪些方向入手？又应该怎么做？” - -开发者可以从处理 Issues 入手，[这里](https://github.com/NervJS/taro/issues?q=label%3A%22good+first+issue%22+is%3Aissue+is%3Aopen)会列出所有被标记为 **good first issue** 的 Issues，这是社区专门留给新贡献者的相对简单的入门级 Issues。也可以通过通过 Label 筛选出 **Helper Wanted** 的 Issues，并且会被分为 `Easy`、 `Medium`、 `Hard` 三种难易程度。 - -除了帮忙处理 Issues，Taro 还有很多方向需要人力进行建设。 - -随着对 Taro 内部运行机制的熟悉，开发者可能会产生一些新的想法，例如希望开发一些新的功能等。这时需要先编写 RFC 文档，在社区谈论完善后再开始编码。 - -在开发之前请先阅读[《Taro 的仓库概览》](./codebase-overview)以及[《贡献指南》](./CONTRIBUTING-GUIDE#贡献代码)，它们介绍了 Taro 仓库构成、如何开发和提交规范等信息。 - -如果是首次提交代码，可参考文章：[如何参与大型开源项目-Taro 共建](/blog/2022-01-19-how-to-join-Taro)。 - -### 工具分享 - -在社区分享你的 “轮子”（例如**SDK**、**组件**、**插件**、**UI 库**、**开源项目**等）。 - -可以提交到 [Taro 物料市场](https://taro-ext.jd.com)、文档[《社区优质物料》](./treasures) 、仓库 [awesome-taro](https://github.com/NervJS/awesome-taro) 里，并提供完善的说明。然后在 [Taro 论坛](https://github.com/NervJS/taro/discussions/categories/%E7%94%9F%E6%80%81) 中添加一条讨论，与开发者进行沟通。 - -Taro 团队会定期甄选优秀的物料汇集成文，在 Taro 社区和各大有影响力的前端渠道进行推广。 - -### 案例分享 - -分享你的成功案例，可以提交到 [taro-user-cases](https://github.com/NervJS/taro-user-cases)（只需提交小程序码、二维码）。 - -### 文章投稿 - -分享你的经验（教程、文章等），可以给「Taro 社区」公众号投稿。 - -## Credits - -感谢以下所有给 Taro 贡献过代码的开发者： - - diff --git a/versioned_docs/version-4.x/GETTING-STARTED.mdx b/versioned_docs/version-4.x/GETTING-STARTED.mdx deleted file mode 100644 index 3334b66a4dcc..000000000000 --- a/versioned_docs/version-4.x/GETTING-STARTED.mdx +++ /dev/null @@ -1,711 +0,0 @@ ---- -title: 安装及使用 ---- - -import TabItem from '@theme/TabItem' -import Tabs from '@theme/Tabs' - -## 安装 - -Taro 项目基于 node，请确保已具备较新的 node 环境（>=16.20.0），推荐使用 node 版本管理工具 [nvm](https://github.com/creationix/nvm) 来管理 node，这样不仅可以很方便地切换 node 版本，而且全局安装时候也不用加 sudo 了。 - -### CLI 工具安装 - -首先，你需要使用 npm 或者 yarn 全局安装 `@tarojs/cli`，或者直接使用 [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b): - - - - -```bash -# 使用 npm 安装 CLI -$ npm install -g @tarojs/cli -``` - - - - - -```bash -# 使用 yarn 安装 CLI -$ yarn global add @tarojs/cli -``` - - - - - -```bash -# 使用 pnpm 安装 CLI -$ pnpm install -g @tarojs/cli -``` - - - - -:::caution 请注意 -由于 Taro 部分能力使用 Rust 开发，在 Windows上，请确保安装了 Microsoft Visual C++ Redistributable。请查看：https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist。 - -::: - -#### 查看 Taro 全部版本信息 - -可以使用 `npm info` 查看 Taro 版本信息，在这里你可以看到当前最新版本 - -```bash -npm info @tarojs/cli -``` - -![npm info @tarojs/cli screenshot](https://img13.360buyimg.com/ling/jfs/t1/144770/7/20011/138415/5fe40491Ed0883578/11236962a3e672db.png) - -由图第 1 行可知最新版本，如果你用的是 beta 或者 canary 你可以通过 `dist-tags:` 下面那行看到最新的版本。 - -## 项目初始化 - -使用命令创建模板项目： - -```bash -$ taro init myApp -``` - -npm 5.2+ 也可在不全局安装的情况下使用 npx 创建模板项目： - -```bash -$ npx @tarojs/cli init myApp -``` - -![taro init myApp command screenshot](https://img30.360buyimg.com/ling/jfs/t1/121270/15/15083/672721/5f89357dEf36b7fe2/ecb98df1436cd3d5.jpg) - -在创建完项目之后，Taro 会默认开始安装项目所需要的依赖，安装使用的工具按照 yarn > cnpm > npm 顺序进行检测。一般来说，依赖安装会比较顺利，但某些情况下可能会安装失败，这时候你可以在项目目录下自己使用安装命令进行安装： - - - - -```bash -# 进入项目根目录 -$ cd myApp - -# 使用 npm 安装依赖 -$ npm install -``` - - - - - -```bash -# 进入项目根目录 -$ cd myApp - -# 使用 yarn 安装依赖 -$ yarn -``` - - - - - -```bash -# 进入项目根目录 -$ cd myApp - -# 使用 pnpm 安装依赖 -$ pnpm install -``` - - - - -## 编译运行 - -使用 Taro 的 `build` 命令可以把 Taro 代码编译成不同端的代码，然后在对应的开发工具中查看效果。 - -Taro 编译分为 `dev` 和 `build` 模式： - -- **dev 模式（增加 --watch 参数）** 将会监听文件修改。 -- **build 模式（去掉 --watch 参数）** 将不会监听文件修改，并会对代码进行压缩打包。 -- dev 模式生成的文件较大，设置环境变量 `NODE_ENV` 为 `production` 可以开启压缩，方便预览，但编译速度会下降。 - -### 微信小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:weapp -$ yarn build:weapp - -# npm script -$ npm run dev:weapp -$ npm run build:weapp - -# 仅限全局安装 -$ taro build --type weapp --watch -$ taro build --type weapp - -# npx 用户也可以使用 -$ npx taro build --type weapp --watch -$ npx taro build --type weapp - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type weapp --watch # CMD -$ NODE_ENV=production taro build --type weapp --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开[微信开发者工具](https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html)，然后选择**项目根目录**进行预览。 - -需要注意开发者工具的项目设置： - -- 需要设置关闭 ES6 转 ES5 功能，开启可能报错 -- 需要设置关闭上传代码时样式自动补全，开启可能报错 -- 需要设置关闭代码压缩上传，开启可能报错 - -### 百度小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:swan -$ yarn build:swan - -# npm script -$ npm run dev:swan -$ npm run build:swan - -# 仅限全局安装 -$ taro build --type swan --watch -$ taro build --type swan - -# npx 用户也可以使用 -$ npx taro build --type swan --watch -$ npx taro build --type swan - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type swan --watch # CMD -$ NODE_ENV=production taro build --type swan --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开[百度开发者工具](https://smartprogram.baidu.com/docs/develop/devtools/show_sur/)，并确保已经设置了小程序项目配置文件 [project.swan.json](./project-config)。然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -需要注意开发者工具的项目设置： - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -### 支付宝小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:alipay -$ yarn build:alipay - -# npm script -$ npm run dev:alipay -$ npm run build:alipay - -# 仅限全局安装 -$ taro build --type alipay --watch -$ taro build --type alipay - -# npx 用户也可以使用 -$ npx taro build --type alipay --watch -$ npx taro build --type alipay - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type alipay --watch # CMD -$ NODE_ENV=production taro build --type alipay --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开[支付宝小程序开发者工具](https://docs.alipay.com/mini/developer/getting-started/)，然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -需要注意开发者工具的项目设置： - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -### 抖音小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:tt -$ yarn build:tt - -# npm script -$ npm run dev:tt -$ npm run build:tt - -# 仅限全局安装 -$ taro build --type tt --watch -$ taro build --type tt - -# npx 用户也可以使用 -$ npx taro build --type tt --watch -$ npx taro build --type tt - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type tt --watch # CMD -$ NODE_ENV=production taro build --type tt --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开[抖音小程序开发者工具](https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/develop/developer-instrument/download/developer-instrument-update-and-download)，并确保已经设置了小程序项目配置文件 [project.tt.json](./project-config)。然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -需要注意开发者工具的项目设置： - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -### QQ 小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:qq -$ yarn build:qq - -# npm script -$ npm run dev:qq -$ npm run build:qq - -# 仅限全局安装 -$ taro build --type qq --watch -$ taro build --type qq - -# npx 用户也可以使用 -$ npx taro build --type qq --watch -$ npx taro build --type qq - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type qq --watch # CMD -$ NODE_ENV=production taro build --type qq --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开 [QQ 小程序开发者工具](https://q.qq.com/wiki/#_4-%E7%BC%96%E7%A0%81%E5%BC%80%E5%8F%91%E5%B0%8F%E7%A8%8B%E5%BA%8F)，然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -需要注意开发者工具的项目设置： - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -### 京东小程序 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:jd -$ yarn build:jd - -# npm script -$ npm run dev:jd -$ npm run build:jd - -# 仅限全局安装 -$ taro build --type jd --watch -$ taro build --type jd - -# npx 用户也可以使用 -$ npx taro build --type jd --watch -$ npx taro build --type jd - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type jd --watch # CMD -$ NODE_ENV=production taro build --type jd --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开京东小程序开发者工具（前往https://mp.jd.com 注册，申请成功后将会获得开发者工具），然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -需要注意开发者工具的项目设置： - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -#### 京东小程序相关阅读 - -- [《使用 Taro 快速开发京东小程序》](/blog/2020-04-27-taro-build-jd) -- [《京东小程序 Taro 开发对比原生开发测评》](/blog/2020-04-27-taro-vs-jd) - -### 企业微信小程序 - -:::note -Taro v3.1+ 开始支持 -::: - -使用 Taro 插件能支持编译企业微信小程序，插件文档请看 [Github](https://github.com/NervJS/taro-plugin-platform-weapp-qy)。 - -#### 安装插件 - -```bash -yarn add @tarojs/plugin-platform-weapp-qy -``` - -#### 配置插件 - -```js title="Taro 项目配置" -config = { - // ... - plugins: ['@tarojs/plugin-platform-weapp-qy'], -} -``` - -#### 编译命令 - -```bash -# yarn -$ yarn dev:qywx -$ yarn build:qywx - -# npm script -$ npm run dev:qywx -$ npm run build:qywx - -# 仅限全局安装 -$ taro build --type qywx --watch -$ taro build --type qywx - -# npx 用户也可以使用 -$ npx taro build --type qywx --watch -$ npx taro build --type qywx - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type qywx --watch # CMD -$ NODE_ENV=production taro build --type qywx --watch # Bash -``` - -#### 小程序开发者工具 - -同微信小程序。开发者工具的编译模式设置为企业微信。 - -### 钉钉小程序 - -:::note -Taro v3.1+ 开始支持 - -**Taro v3.3.8+**： -请使用 `@tarojs/plugin-platform-alipay-dd` 插件的 `~0.1.0` 版本 - -**Taro v3.1 & v3.2**： -请使用 `@tarojs/plugin-platform-alipay-dd` 插件的 `~0.0.5` 版本 -::: - -使用 Taro 插件能支持编译钉钉小程序，插件文档请看 [Github](https://github.com/NervJS/taro-plugin-platform-alipay-dd)。 - -#### 安装插件 - -```bash -yarn add @tarojs/plugin-platform-alipay-dd -``` - -#### 配置插件 - -```js title="Taro 项目配置" -config = { - // ... - plugins: ['@tarojs/plugin-platform-alipay-dd'], -} -``` - -#### 编译命令 - -```bash -# yarn -$ yarn dev:dd -$ yarn build:dd - -# npm script -$ npm run dev:dd -$ npm run build:dd - -# 仅限全局安装 -$ taro build --type dd --watch -$ taro build --type dd - -# npx 用户也可以使用 -$ npx taro build --type dd --watch -$ npx taro build --type dd - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type dd --watch # CMD -$ NODE_ENV=production taro build --type dd --watch # Bash -``` - -#### 小程序开发者工具 - -同支付宝小程序。开发者工具的编译模式设置为钉钉。 - -### 支付宝 IOT 小程序 - -:::note -Taro v3.1+ 开始支持 -::: - -使用 Taro 插件能支持编译支付宝 IOT 小程序，插件文档请看 [Github](https://github.com/NervJS/taro-plugin-platform-alipay-iot)。 - -#### 安装插件 - -```bash -yarn add @tarojs/plugin-platform-alipay-iot -``` - -#### 配置插件 - -```js title="Taro 项目配置" -config = { - // ... - plugins: ['@tarojs/plugin-platform-alipay-iot'], -} -``` - -#### 编译命令 - -```bash -# yarn -$ yarn dev:iot -$ yarn build:iot - -# npm script -$ npm run dev:iot -$ npm run build:iot - -# 仅限全局安装 -$ taro build --type iot --watch -$ taro build --type iot - -# npx 用户也可以使用 -$ npx taro build --type iot --watch -$ npx taro build --type iot - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type iot --watch # CMD -$ NODE_ENV=production taro build --type iot --watch # Bash -``` - -#### 小程序开发者工具 - -同支付宝小程序。开发者工具的编译模式设置为 IOT 小程序。 - -### 飞书小程序 - -:::note -Taro v3.1+ 开始支持 -::: - -使用 Taro 插件能支持编译[飞书小程序](https://open.feishu.cn/document/uYjL24iN/uMjNzUjLzYzM14yM2MTN?from=taro)，插件文档请看 [Github](https://github.com/NervJS/taro-plugin-platform-lark)。 - -#### 安装插件 - -```bash -yarn add @tarojs/plugin-platform-lark -``` - -#### 配置插件 - -```js title="Taro 项目配置" -config = { - // ... - plugins: ['@tarojs/plugin-platform-lark'], -} -``` - -#### 编译命令 - -```bash -# yarn -$ yarn dev:lark -$ yarn build:lark - -# npm script -$ npm run dev:lark -$ npm run build:lark - -# 仅限全局安装 -$ taro build --type lark --watch -$ taro build --type lark - -# npx 用户也可以使用 -$ npx taro build --type lark --watch -$ npx taro build --type lark - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type lark --watch # CMD -$ NODE_ENV=production taro build --type lark --watch # Bash -``` - -#### 小程序开发者工具 - -[飞书小程序](https://open.feishu.cn/document/uYjL24iN/uMjNzUjLzYzM14yM2MTN?from=taro)能运行在飞书客户端上，且一套代码多端运行(包括 PC 端和移动端)。你需要下载并打开[飞书小程序开发者工具](https://open.feishu.cn/document/uYjL24iN/ucDOzYjL3gzM24yN4MjN?from=taro)，并确保已经设置了小程序项目配置文件。然后选择项目根目录下 `dist` 目录进行预览。 - -需要注意开发者工具的项目配置 - -- 需要关闭 ES6 转 ES5 功能，开启可能报错 -- 需要关闭上传代码时样式自动补全，开启可能报错 -- 需要关闭代码压缩上传，开启可能报错 - -### 快手小程序 - -使用 Taro 插件能支持编译快手小程序，插件文档请看 [Github](https://github.com/NervJS/taro-plugin-platform-kwai)。 - -:::note -Taro v3.1+ 开始支持 - -**Taro v3.3+**： -请使用 [taro-plugin-platform-kwai](https://github.com/NervJS/taro-plugin-platform-kwai) 插件的 `1.0` 或以上版本 - -**Taro v3.2**： -请使用 [taro-plugin-platform-ks](https://github.com/vadxq/taro-plugin-platform-ks) 插件的 `1.2.x` 版本 - -**Taro v3.1**： -请使用 [taro-plugin-platform-ks](https://github.com/vadxq/taro-plugin-platform-ks) 插件的 `1.0.x` 版本 -::: - -#### 安装插件 - -```bash -yarn add @tarojs/plugin-platform-kwai -``` - -#### 配置插件 - -```js title="Taro 项目配置" -config = { - // ... - plugins: ['@tarojs/plugin-platform-kwai'], -} -``` - -#### 编译命令 - -```bash -# yarn -$ yarn dev:kwai -$ yarn build:kwai - -# npm script -$ npm run dev:kwai -$ npm run build:kwai - -# 仅限全局安装 -$ taro build --type kwai --watch -$ taro build --type kwai - -# npx 用户也可以使用 -$ npx taro build --type kwai --watch -$ npx taro build --type kwai - -# watch 同时开启压缩 -$ set NODE_ENV=production && taro build --type kwai --watch # CMD -$ NODE_ENV=production taro build --type kwai --watch # Bash -``` - -#### 小程序开发者工具 - -下载并打开[快手小程序开发者工具](https://mp.kuaishou.com/docs/develop/guide/introduction.html)，然后选择项目根目录下 `dist` 目录（根目录 `config` 中的 `outputRoot` 设置的目录）进行预览。 - -### H5 - -#### 编译命令 - -```bash -# yarn -$ yarn dev:h5 -$ yarn build:h5 - -# npm script -$ npm run dev:h5 -$ npm run build:h5 - -# 仅限全局安装 -$ taro build --type h5 --watch -$ taro build --type h5 - -# npx 用户也可以使用 -$ npx taro build --type h5 --watch -$ npx taro build --type h5 -``` - -### React Native - -> Taro v3.2+ 开始支持 - -请参考 [React Native 端开发流程](./react-native) - -## 渐进式入门教程 - -我们提供了一个由浅入深的实战教程，请参考[《教程》](./guide)。 - -## 常见问题 - -### 保持 CLI 的版本与各端依赖版本一致 - -在使用 Taro 进行多端开发中，请保持 Taro CLI 的版本与你项目的依赖版本一致，否则可能会出现编译错误或者运行时错误。 - -如果发现不一致的情况可以使用 Taro 升级命令 taro update self [版本号] 和 taro update project [版本号]来分别将 CLI 和项目依赖升级到指定版本； -或者也可以手动安装相应版本 CLI，修改 package.json 依赖版本号，然后重装依赖来解决。 - -```bash -# 使用Taro 升级命令更新CLI版本到最新版本 -$ taro update self -# 使用Taro 升级命令更新CLI版本到指定版本 -$ taro update self [版本号] -# 使用Taro 升级命令将项目依赖升级到与@tarojs/cli一致的版本 -$ taro update project -# 使用Taro 升级命令将项目依赖升级到指定版本 -$ taro update project [版本号] -``` - -如果你所使用的 Taro CLI 版本为 3.0.9，而项目里使用的依赖版本为 3.0.10，则有可能会出现问题，这时请将你的 Taro CLI 版本更新至项目依赖版本号相同的版本，如果还是出现问题，请向我们提出 [Issue](https://nervjs.github.io/taro-issue-helper/)。 - -### Taro 多版本共存问题 - -很多开发者曾经使用 Taro 旧版本开发过项目，已经在全局安装了 Taro，但是想同时体验到 Taro 4，应该如何进行操作？ - -我们提供了两种思路： - -- 如果是需要新创建 Taro 4 项目，可以使用 [nvm](https://github.com/nvm-sh/nvm) 来管理 node 版本，通过安装不同 node 版本来安装不同版本的 Taro CLI，从而解决 Taro 多版本共存的问题 -- 如果是部分已有项目需要升级到 Taro 4，可以在这些项目本地安装相应版本的 Taro CLI，这样通过 `yarn` 或者 `npm` 执行命令的话就会直接使用本地安装的 Taro CLI，安装方式 `yarn add @tarojs/cli` - -### 回到某个版本 - -需要安装某个固定版本，或者回到某个版本，例如我们要安装 `1.3.9` ， 则如下： - -```bash -# 使用 npm 安装 CLI -$ npm install -g @tarojs/cli@1.3.9 -# OR 使用 yarn 安装 CLI -$ yarn global add @tarojs/cli@1.3.9 -# OR 安装了 cnpm，使用 cnpm 安装 CLI -$ cnpm install -g @tarojs/cli@1.3.9 -``` diff --git a/versioned_docs/version-4.x/README.mdx b/versioned_docs/version-4.x/README.mdx deleted file mode 100644 index 035a20605e86..000000000000 --- a/versioned_docs/version-4.x/README.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: Taro 介绍 ---- - -import Link from '@docusaurus/Link' -import { ReactIcon, VueIcon } from '@site/static/icons' -import TabItem from '@theme/TabItem' -import Tabs from '@theme/Tabs' - -import News from './news' - -## 简介 - -**Taro** 是一个开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发 [微信](https://mp.weixin.qq.com/) / [京东](https://mp.jd.com/?entrance=taro) / [百度](https://smartprogram.baidu.com/) / [支付宝](https://mini.open.alipay.com/) / [字节跳动](https://developer.open-douyin.com/) / [QQ](https://q.qq.com/) / [飞书](https://open.feishu.cn/document/uYjL24iN/ucDOzYjL3gzM24yN4MjN) 小程序 / H5 / RN 等应用。 - -现如今市面上端的形态多种多样，Web、React Native、微信小程序等各种端大行其道。当业务要求同时在不同的端都要求有所表现的时候，针对不同的端去编写多套代码的成本显然非常高，这时候只编写一套代码就能够适配到多端的能力就显得极为需要。 - -## 特性 - -### 多端转换支持 - -Taro 3 可以支持转换到 H5、ReactNative 以及任意小程序平台。 - -目前官方支持转换的平台如下： - -- [ H5](https://developer.mozilla.org/zh-CN/docs/Web?from=taro) -- [ React Native](https://reactnative.dev/?from=taro) -- [ 微信小程序](https://developers.weixin.qq.com/miniprogram/dev/framework/?from=taro) -- [ 京东小程序](https://mp.jd.com/?from=taro) -- [ 百度智能小程序](https://smartprogram.baidu.com/developer/index.html?from=taro) -- [ 支付宝小程序](https://opendocs.alipay.com/mini/developer/getting-started?from=taro) -- [ 抖音小程序](https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/introduction/overview?from=taro) -- [ QQ 小程序](https://q.qq.com/wiki/develop/miniprogram/frame/?from=taro) -- [ 钉钉小程序](https://open.dingtalk.com/document/org/develop-org-mini-programs?from=taro) -- [ 企业微信小程序](https://developers.weixin.qq.com/miniprogram/dev/devtools/qywx-dev.html?from=taro) -- [ 支付宝 IOT 小程序](https://opendocs.alipay.com/iot/multi-platform/vcs0fv?from=taro) -- [ 飞书小程序](https://open.feishu.cn/document/uYjL24iN/uMjNzUjLzYzM14yM2MTN?from=taro) - -### 框架支持 - -在 Taro 3 中可以使用完整的 [** React**](https://react.dev/) / [** Vue**](https://vuejs.org/) / [** Preact**](https://preactjs.com/) / [** Svelte**](https://svelte.dev/) / [** Nerv**](https://github.com/NervJS/nerv) 开发体验，具体请参考： - -- [基础教程——React](./react-overall) -- [基础教程——Vue](./vue-overall) -- [基础教程——Vue3](./vue3) -- [基础教程——Preact](./preact) - -, value: 'React'}, - {label: , value: 'Vue'} - ]}> - - -```jsx title="示例代码" -import React, { Component } from 'react' -import { View, Text } from '@tarojs/components' - -export default class Index extends Component { - state = { - msg: 'Hello World！', - } - - componentWillMount() {} - - componentDidShow() {} - - componentDidHide() {} - - render() { - return ( - - {this.state.msg} - - ) - } -} -``` - - - - - -```html title="示例代码" - - - -``` - - - - -## 新闻资讯 - - - -## Taro UI - -> Taro 3 只能配合使用 taro-ui@next 版本 -> -> 安装命令： `npm i taro-ui@next` - -一款基于 `Taro` 框架开发的多端 UI 组件库。 - -[Taro UI](https://taro-ui.jd.com) 特性： - -- 基于 `Taro` 开发 UI 组件 -- 一套组件可以在多端适配运行（`ReactNative` 端暂不支持） -- 提供友好的 API，可灵活的使用组件 - -## 学习资源 - -[【资讯】Taro 团队博客](/blog) - -[【教程】5 分钟上手 Taro 开发](/docs/guide) - -[【视频】5 分钟快速上手 Taro 开发小程序](https://mp.weixin.qq.com/s?__biz=MzU3NDkzMTI3MA==&mid=2247484205&idx=1&sn=935bb7a35c11c33563eeb7c3aaca3321&chksm=fd2bab04ca5c2212b4cd8aeb5858bd08517aeb31e20727b22d1eee00b394184e7e61359e7dd9&token=1180618535&lang=zh_CN#rd) - -[【掘金小册】Taro 多端开发实现原理与实战](https://juejin.im/book/5b73a131f265da28065fb1cd?referrer=5ba228f16fb9a05d3251492d) (已下架，仅购买用户可阅) - -更多的资源请点击查看 [更多资源](./composition.md) ，如果您有好的资源或教程和大家分享，欢迎提交资源到 [awesome-taro](https://github.com/NervJS/awesome-taro)。 - -## 项目状态 - -![[](https://github.com/NervJS/taro/pulse)](https://repobeats.axiom.co/api/embed/275806b6f177f7e4c005e956d94440562635c36d.svg "Repobeats analytics image") - -## 使用案例 - -Taro 已经投入了我们的生产环境中使用，业界也在广泛地使用 Taro 开发多端应用。 - -查看更多的案例，请点击 - -[我们正在征集更多优秀案例，欢迎点击提交](https://github.com/NervJS/taro/issues/244) - -![[](https://nervjs.github.io/taro-user-cases/)](https://raw.githubusercontent.com/NervJS/taro-user-cases/master/user-cases.jpg) diff --git a/versioned_docs/version-4.x/apis/General.md b/versioned_docs/version-4.x/apis/General.md deleted file mode 100644 index 835676770e7a..000000000000 --- a/versioned_docs/version-4.x/apis/General.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: General -sidebar_label: General ---- - -## 参数 - -### CallbackResult - -通用错误 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -### BluetoothError - -蓝牙错误 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `0 | 10000 | 10001 | 10002 | 10003 | 10004 | 10005 | 10006 | 10007 | 10008 | 10009 | 10012 | 10013` | 错误码 | - -### WifiError - -WIFI 错误 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `0 | 12000 | 12001 | 12002 | 12003 | 12004 | 12005 | 12006 | 12007 | 12008 | 12009 | 12010 | 12011 | 12013` | 错误码 | - -### NFCError - -NFC 错误 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `0 | 13000 | 13001 | 13002 | 13003 | 13004 | 13005 | 13006` | 错误码 | - -### IBeaconError - -iBeacon 错误 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `0 | 11000 | 11001 | 11002 | 11003 | 11004 | 11005 | 11006` | 错误码 | - -### SafeAreaResult - -在竖屏正方向下的安全区域 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bottom | `number` | 安全区域右下角纵坐标 | -| height | `number` | 安全区域的高度，单位逻辑像素 | -| left | `number` | 安全区域左上角横坐标 | -| right | `number` | 安全区域右下角横坐标 | -| top | `number` | 安全区域左上角纵坐标 | -| width | `number` | 安全区域的宽度，单位逻辑像素 | - -### AdErrCode - -广告错误码 - -错误码是通过onError获取到的错误信息。调试期间，可以通过异常返回来捕获信息。 -在小程序发布上线之后，如果遇到异常问题，可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志，还可以针对异常返回加上适当的监控信息。 - -| 参数 | 异常情况 | 理由 | 解决方案 | -| --- | :---: | :---: | :---: | -| 1000 | `后端接口调用失败` | `该项错误不是开发者的异常情况` | `一般情况下忽略一段时间即可恢复。` | -| 1001 | `参数错误` | `使用方法错误` | `可以前往 developers.weixin.qq.com 确认具体教程（小程序和小游戏分别有各自的教程，可以在顶部选项中，“设计”一栏的右侧进行切换。` | -| 1002 | `广告单元无效` | `可能是拼写错误、或者误用了其他APP的广告ID` | `请重新前往 mp.weixin.qq.com 确认广告位ID。` | -| 1003 | `内部错误` | `该项错误不是开发者的异常情况` | `一般情况下忽略一段时间即可恢复。` | -| 1004 | `无合适的广告` | `广告不是每一次都会出现，这次没有出现可能是由于该用户不适合浏览广告` | `属于正常情况，且开发者需要针对这种情况做形态上的兼容。` | -| 1005 | `广告组件审核中` | `你的广告正在被审核，无法展现广告` | `请前往 mp.weixin.qq.com 确认审核状态，且开发者需要针对这种情况做形态上的兼容。` | -| 1006 | `广告组件被驳回` | `你的广告审核失败，无法展现广告` | `请前往 mp.weixin.qq.com 确认审核状态，且开发者需要针对这种情况做形态上的兼容。` | -| 1007 | `广告组件被封禁` | `你的广告能力已经被封禁，封禁期间无法展现广告` | `请前往 mp.weixin.qq.com 确认小程序广告封禁状态。` | -| 1008 | `广告单元已关闭` | `该广告位的广告能力已经被关闭` | `请前往 mp.weixin.qq.com 重新打开对应广告位的展现。` | - -### BluetoothErrCode - -蓝牙错误码 - -| 参数 | 异常情况 | 说明 | -| --- | :---: | --- | -| 0 | `ok` | 正常 | -| 10000 | `not init` | 未初始化蓝牙适配器 | -| 10001 | `not available` | 当前蓝牙适配器不可用 | -| 10002 | `no device` | 没有找到指定设备 | -| 10003 | `connection fail` | 连接失败 | -| 10004 | `no service` | 没有找到指定服务 | -| 10005 | `no characteristic` | 没有找到指定特征值 | -| 10006 | `no connection` | 当前连接已断开 | -| 10007 | `property not support` | 当前特征值不支持此操作 | -| 10008 | `system error` | 其余所有系统上报的异常 | -| 10009 | `system not support` | Android 系统特有，系统版本低于 4.3 不支持 BLE | -| 10012 | `operate time out` | 连接超时 | -| 10013 | `invalid_data` | 连接 deviceId 为空或者是格式不正确 | - -### IBeaconErrCode - -iBeacon 错误码 - -| 参数 | 异常情况 | 说明 | -| --- | :---: | --- | -| 0 | `ok` | 正常 | -| 11000 | `unsupport` | 系统或设备不支持 | -| 11001 | `bluetooth service unavailable` | 蓝牙服务不可用 | -| 11002 | `location service unavailable` | 位置服务不可用 | -| 11003 | `already start` | 已经开始搜索 | -| 11004 | `not startBeaconDiscovery` | 还未开始搜索 | -| 11005 | `system error` | 系统错误 | -| 11006 | `invalid data` | 参数不正确 | - -### WifiErrCode - -WIFI 错误码 - -| 参数 | 异常情况 | 说明 | -| --- | :---: | --- | -| 0 | `ok` | 正常 | -| 12000 | `not init` | 未先调用 `startWifi` 接口 | -| 12001 | `system not support` | 当前系统不支持相关能力 | -| 12002 | `password error Wi-Fi` | 密码错误 | -| 12003 | `connection timeout` | 连接超时 | -| 12004 | `duplicate request` | 重复连接 Wi-Fi | -| 12005 | `wifi not turned on` | Android 特有，未打开 Wi-Fi 开关 | -| 12006 | `wifi not turned on` | Android 特有，未打开 GPS 定位开关 | -| 12007 | `user denied` | 用户拒绝授权链接 Wi-Fi | -| 12008 | `invalid SSID` | 无效 SSID | -| 12009 | `system config err` | 系统运营商配置拒绝连接 Wi-Fi | -| 12010 | `system internal error` | 系统其他错误，需要在 errmsg 打印具体的错误原因 | -| 12011 | `weapp in background` | 应用在后台无法配置 Wi-Fi | -| 12013 | `wifi config may be expired` | 系统保存的 Wi-Fi 配置过期，建议忘记 Wi-Fi 后重试 | - -### NFCErrCode - -NFC 错误码 - -| 参数 | 异常情况 | 说明 | -| --- | :---: | --- | -| 0 | `ok` | 正常 | -| 13000 | | 当前设备不支持NFC | -| 13001 | | 当前设备支持NFC，但系统NFC开关未开启 | -| 13002 | | 当前设备支持NFC，但不支持HCE | -| 13003 | | AID列表参数格式错误 | -| 13004 | | 未设置微信为默认NFC支付应用 | -| 13005 | | 返回的指令不合法 | -| 13006 | | 注册AID失败 | - -### LaunchOptionsApp - -启动参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| path | `string` | 启动小程序的路径 | -| query | `Record` | 启动小程序的 query 参数 | -| referrerInfo | `ReferrerInfo` | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) | -| scene | `number` | 启动小程序的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) | -| shareTicket | `string` | shareTicket，详见[获取更多转发信息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | - -#### ReferrerInfo - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 来源小程序、公众号或 App 的 appId | -| extraData | `Record` | 来源小程序传过来的数据，scene=1037或1038时支持 | diff --git a/versioned_docs/version-4.x/apis/about/desc.md b/versioned_docs/version-4.x/apis/about/desc.md deleted file mode 100644 index 5b4fbbba75a6..000000000000 --- a/versioned_docs/version-4.x/apis/about/desc.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: API 说明 ---- - -Taro 的 API 包括 Taro 内置提供的 API 以及对小程序的端能力 API 的封装。 - -其中对小程序的端能力 API 的封装，主要会基于微信小程序的 API 规范，对于其他小程序类似的 API，会在 Taro 中适配为小程序 API 的规范格式，并且都挂载在 `Taro` 命名空间下。 - -例如，支付宝小程序中，`my.alert` 用于弹出一个警告的模态框，而微信小程序中没有这一 API，与之类似的有 `wx.showModal`，所以在 Taro 中会将支付宝的 `my.alert` 统一为 `Taro.showModal`，从而减少一些跨平台兼容代码的书写。 - -而对于微信小程序中没有，而某些小程序平台特有的 API，可以先尝试用 `Taro.` + API 名称来进行调用，如果出现未定义，则使用对应小程序平台的命名空间（如 `my`、`swan`、`tt` 等）来进行调用，并反馈给我们。 - -当然，由于各个小程序平台的迭代非常快速，Taro 要不断跟进小程序的更新，有时候难免有些 API 没有加入 Taro 适配，你可以通过提 PR 或者 issue，来获得帮助。 - -同时，为了方便代码书写，Taro 默认对小程序的异步 API 进行了 `promisify` 化，你可以像使用 Promise 那样进行调用，例如 - -```js -import Taro from '@tarojs/taro' - -Taro.request(url).then(function (res) { - console.log(res) -}) -``` - - - diff --git a/versioned_docs/version-4.x/apis/about/env.md b/versioned_docs/version-4.x/apis/about/env.md deleted file mode 100644 index e4ec2af19e05..000000000000 --- a/versioned_docs/version-4.x/apis/about/env.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: 环境判断 ---- - -## Taro.ENV_TYPE - -`ENV_TYPE.WEAPP` 微信小程序环境 - -`ENV_TYPE.SWAN` 百度小程序环境 - -`ENV_TYPE.ALIPAY` 支付宝小程序环境 - -`ENV_TYPE.TT` 抖音小程序环境 - -`ENV_TYPE.WEB` WEB(H5)环境 - -`ENV_TYPE.RN` ReactNative 环境 - -`ENV_TYPE.QUICKAPP` 快应用环境 - -`ENV_TYPE.QQ` QQ小程序 环境 - -`ENV_TYPE.JD` 京东小程序 环境 - -## Taro.getEnv() - -获取当前环境值，具体值如上 `Taro.ENV_TYPE` diff --git a/versioned_docs/version-4.x/apis/about/events.md b/versioned_docs/version-4.x/apis/about/events.md deleted file mode 100644 index 9f26b324c98e..000000000000 --- a/versioned_docs/version-4.x/apis/about/events.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: 消息机制 ---- - -Taro 提供了 `Taro.Events` 来实现消息机制，使用时需要实例化它，如下 - -```jsx -import Taro, { Events } from '@tarojs/taro' - -const events = new Events() - -// 监听一个事件，接受参数 -events.on('eventName', (arg) => { - // doSth -}) - -// 监听同个事件，同时绑定多个 handler -events.on('eventName', handler1) -events.on('eventName', handler2) -events.on('eventName', handler3) - -// 触发一个事件，传参 -events.trigger('eventName', arg) - -// 触发事件，传入多个参数 -events.trigger('eventName', arg1, arg2, ...) - -// 取消监听一个事件 -events.off('eventName') - -// 取消监听一个事件某个 handler -events.off('eventName', handler1) - -// 取消监听所有事件 -events.off() -``` - -同时 Taro 还提供了一个全局消息中心 `Taro.eventCenter` 以供使用，它是 `Taro.Events` 的实例 - -```jsx -import Taro from '@tarojs/taro' - -Taro.eventCenter.on -Taro.eventCenter.trigger -Taro.eventCenter.off -``` diff --git a/versioned_docs/version-4.x/apis/about/tarocomponent.md b/versioned_docs/version-4.x/apis/about/tarocomponent.md deleted file mode 100644 index 5b5277f5fc1a..000000000000 --- a/versioned_docs/version-4.x/apis/about/tarocomponent.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: Taro.Component ---- - -`Taro.Component` 是一个抽象基础类，因此直接引用 `Taro.Component` 几乎没意义。相反，你通常会继承自它，并至少定义一个 `render()` 方法。 - -通常你定义一个 `Taro` 组件相当于一个纯 `JavaScript` 类： - -```jsx -class Welcome extends Component { - render () { - return

Hello, {this.props.name}

- } -} -``` - -> 这里 Taro 和 React 不一样的地方在于没有暴露出一个 `createClass` 的方法，你只能用 ES6 的 class 类来创建 Taro 组件。 - -## 组件生命周期 - -每一个组件都有几个你可以重写以让代码在处理环节的特定时期运行的“生命周期方法”。方法中带有前缀 `will` 的在特定环节之前被调用，而带有前缀 `did` 的方法则会在特定环节之后被调用。 - -#### 装载(Mounting) - -这些方法会在组件实例被创建和插入 DOM 中时被调用： - -* `constructor()` -* `componentWillMount()` -* `render()` -* `componentDidMount()` - -#### 更新(Updating) - -属性或状态的改变会触发一次更新。当一个组件在被重新渲染时，这些方法将会被调用： - -* `componentWillReceiveProps()` -* `shouldComponentUpdate()` -* `componentWillUpdate()` -* `render()` -* `componentDidUpdate()` - -#### 卸载(Unmounting) - -当一个组件被从 DOM 中移除时，该方法被调用： - -* `componentWillUnmount()` - -#### 其他 API - -每一个组件还提供了其他的 API： - -* `setState()` -* `forceUpdate()` - -#### 类属性 - -* `defaultProps` - -#### 实例属性 - -* `props` -* `state` -* `config`（小程序专属） - -## 参考 - -### render() - -`render()` 方法是必须的。 - -当被调用时，`render` 方法必须返回一个 Taro 组件（可以是内置组件也可以是自定义组件）或一个 [falsy](https://developer.mozilla.org/zh-CN/docs/Glossary/Falsy) 的值。 - -`render()` 函数应该纯净，意味着其不应该改变组件的状态，其每次调用都应返回相同的结果，同时不直接和浏览器/小程序交互。若需要和浏览器/小程序交互，将任务放在`componentDidMount()` 阶段或其他的生命周期方法。保持 `render()` 方法纯净使得组件更容易思考。 - -> 在 React/Nerv 中，`render()` 可以返回多种数据结构，但 Taro 暂时只支持两种。因为 Taro 必须把 JSX 编译成微信小程序模板。当 return 的值为 `falsy` 时，实际上会编译成小程序的 `wx:if` 标签。 - -### constructor() - -```jsx -constructor(props) -``` - -Taro 组件的构造函数将会在装配之前被调用。当为一个 `Taro.Component` 子类定义构造函数时，你应该在任何其他的表达式之前调用 `super(props)`。否则，this.props 在构造函数中将是未定义，并可能引发异常。 - -构造函数是初始化状态的合适位置。若你不初始化状态且不绑定方法，那你也不需要为你的 Taro 组件定义一个构造函数。 - -> 在 Taro 中，即便你不写 constructor()，编译到微信小程序时也会自动给你加上，因为 Taro 运行时框架需要在 constructor() 中多做一些事情。 - -可以基于属性来初始化状态。这样有效地“分离（forks）”属性并根据初始属性设置状态。 - -### `static getDerivedStateFromProps()` - -> 自 v1.3.0 起可用 - -```jsx -static getDerivedStateFromProps(props, state) -``` - -`getDerivedStateFromProps` 会在调用 render 方法之前调用，并且在初始挂载及后续更新时都会被调用。它应返回一个对象来更新 state，如果返回 null 则不更新任何内容。 - -此方法无权访问组件实例（this）。如果你需要，可以通过提取组件 props 的纯函数及 class 之外的状态，在 `getDerivedStateFromProps()` 和其他 class 方法之间重用代码。 - -和 `componentWillReceiveProps` 不同，`getDerivedStateFromProps` 会在每次 `render` 前触发此方法，而 `componentWillReceiveProps` 会在父组件重新渲染时调用。 - -```jsx -export default class ButtonSelectable extends Component { - static propTypes = { - selected: PropTypes.bool, - onClick: PropTypes.func - }; - - constructor(props) { - super(props); - - this.state = { - isSelected: props.selected - }; - } - - static getDerivedStateFromProps(props, state) { - if (props.selected !== state.isSelected) { - return { - isSelected: props.selected - }; - } - - return null; - } - - handleClick = event => { - this.setState({ - isSelected: !this.state.isSelected - }); - }; - - render() { - return ( - - ); - } -} - -``` - -> 请注意： -> getDerivedStateFromProps() 如果存在，`componentWillReceiveProps`、`componentWillMount` 和 `componentWillUpdate` 将不会调用。 -> 当你需要在以上老生命周期 setState 时，我们更推荐你使用 getDerivedStateFromProps 方法，因为它能减少一次更新开销。 - -### getSnapshotBeforeUpdate() - -> 自 v1.3.0 起可用 - -```jsx -getSnapshotBeforeUpdate(prevProps, prevState) -``` - -`getSnapshotBeforeUpdate()` 在最近一次渲染输出（提交到 DOM 节点）之前调用。它使得组件能在发生更改之前从 DOM 中捕获一些信息（例如，滚动位置）。此生命周期的任何返回值将作为参数传递给 `componentDidUpdate()`。 - -应返回 snapshot 的值（或 null）。 - -> 请注意： -> getSnapshotBeforeUpdate() 如果存在，`componentWillReceiveProps`、`componentWillMount` 和 `componentWillUpdate` 将不会调用。 -> 当你需要在以上老生命周期 setState 时，我们更推荐你使用 `getSnapshotBeforeUpdate` 方法，因为它能减少一次更新开销。 - - -### componentWillMount() - -```jsx -componentWillMount() -``` - -`componentWillMount()` 在组件在装载发生前被立刻调用。 - -避免在该方法中引入任何的副作用或订阅。对于这些使用场景，我们推荐使用 constructor() 来替代。 - -这是唯一的会在服务端渲染调起的生命周期钩子函数。 - -> componentWillMount() 在小程序里对应的生命周期是 `onLoad` - -### componentDidMount() - -```jsx -componentDidMount() -``` - -componentDidMount() 在组件被装载后立即调用。初始化使得 DOM 节点应该进行到这里。若你需要从远端加载数据，这是一个适合实现网络请求的地方。在该方法里 `setState()` 将会触发重新渲染。 - -### componentWillReceiveProps() - -```jsx -componentWillReceiveProps(nextProps) -``` - -`componentWillReceiveProps()` 在已经装载的组件接收到新属性前调用。若你需要更新状态响应属性改变，你可能需对比 `this.props` 和 `nextProps` 并在该方法中使用 `this.setState()` 处理状态改变。 - -注意即使属性未有任何改变，Taro 可能也会调用该方法，因此若你想要处理改变，请确保比较当前和之后的值。 - -在装载期间，Taro 并不会调用带有初始属性的 `componentWillReceiveProps`方法。调用 `this.setState` 通常不会触发 `componentWillReceiveProps`。 - -### shouldComponentUpdate() - -```jsx -shouldComponentUpdate(nextProps, nextState) -``` - -使用 `shouldComponentUpdate()` 让 Taro 知道组件的输出是否不受 state 或 props 当前变化的影响。 默认行为是在每次 state 更改时重新渲染，并且在绝大多数情况下，你应该依赖于默认行为。 - -当接收到新的 props 或 state 时，`shouldComponentUpdate()` 在渲染之前被调用。 默认返回 true ，对于初始(第一次)渲染 或 使用 `forceUpdate()` 时，不调用此方法。 - -返回 `false` 不会阻止子组件在 state 更改时重新渲染。 - -### componentWillUpdate() - -```jsx -componentWillUpdate(nextProps, nextState) -``` - -当接收到新的 props 或 state 时，`componentWillUpdate()` 在渲染之前立即被调用。在更新发生之前，使用这个方法可以作为执行准备更新的一个好机会。这个方法在第一次渲染时不会被调用。 - -注意，这里不能调用 `this.setState()` 。 如果你需要更新 state 以响应 props 更改，请改用 `componentWillReceiveProps()`。 - -如果你需要更新 state 来响应 props 的改变，可以使用 `componentWillReceiveProps()` 代替。 - -### componentDidUpdate() - -```jsx -componentDidUpdate(prevProps, prevState) -``` - -`componentDidUpdate()` 在更新发生后立即被调用。 这个方法在第一次渲染时不会被调用。 - -### componentWillUnmount() - -```jsx -componentWillUnmount() -``` - -`componentWillUnmount()` 在一个组件被 卸载(unmounted) 和 销毁(destroyed) 之前立即被调用。 在此方法中执行任何必要的清理，例如使计时器无效，取消网络请求，清除一些可能会造成内存泄露的事件等。 - -> 在小程序中，一个挂在到 `Page` 组件的组件并不会执行 `componentWillUnmount()` 方法，只有当他挂载的 Page 组件被销毁时，该组件才会执行 `componentWillUnmount()` 方法。 - -### setState() - -## 类属性 - -### defaultProps - -`defaultProps` 可以被定义为组件类的一个属性，用以为类设置默认的属性。这对于未定义（undefined）的属性来说有用，而对于设为空（null）的属性并没用。例如： - -```jsx -class CustomButton extends React.Component { - // ... -} - -CustomButton.defaultProps = { - color: 'blue' -} -``` - -若未设置 `props.color`，其将被设置默认为 'blue': - -```jsx -render () { - return // props.color will be set to blue -} -``` - -若 props.color 设为 null，则其值则为 null： - -```jsx -render() { - return // props.color will remain null -} -``` - -## 实例属性 - -### props - -`this.props` 包含了组件该调用者定义的属性。查看 [组件 & Props](../../render-props.md) 关于属性的介绍。 - -### state - -状态是该组件的特定数据，其可能改变多次。状态由用户定义，且其应为纯 JavaScript 对象。 - -若你不在 `render()` 方法中使用它，那它就不应该被放在 state 中。例如，你可直接将 timer IDs 放在实例上。 - -查看 [生命周期 & State](../../state.md) 了解更多关于状态的信息。 - -永远不要直接改变 `this.state`，因为调用 `setState()` 会替换你之前做的改变。将 `this.state` 当成不可变的。 - diff --git a/versioned_docs/version-4.x/apis/ad/InterstitialAd.md b/versioned_docs/version-4.x/apis/ad/InterstitialAd.md deleted file mode 100644 index ec53156760f5..000000000000 --- a/versioned_docs/version-4.x/apis/ad/InterstitialAd.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: InterstitialAd -sidebar_label: InterstitialAd ---- - -插屏广告组件。插屏广告组件是一个原生组件，层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例（小程序端的插屏广告实例不允许跨页面使用），默认是隐藏的，需要调用 InterstitialAd.show() 将其显示。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.html) - -## 方法 - -### destroy - -销毁插屏广告实例。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.destroy.html) - -```tsx -() => void -``` - -### offClose - -取消监听插屏广告关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offClose.html) - -```tsx -(callback: OnCloseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCloseCallback` | - -### offError - -取消监听插屏错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### offLoad - -取消监听插屏广告加载事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.offLoad.html) - -```tsx -(callback: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -### onClose - -监听插屏广告关闭事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.onClose.html) - -```tsx -(callback: OnCloseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCloseCallback` | - -### onError - -监听插屏错误事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.onError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### onLoad - -监听插屏广告加载事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.onLoad.html) - -```tsx -(callback: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -### load - -加载插屏广告。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.load.html) - -```tsx -() => Promise -``` - -### show - -显示插屏广告。 - -**错误码信息表** - -如果插屏广告显示失败，InterstitialAd.show() 方法会返回一个rejected Promise，开发者可以获取到错误码及对应的错误信息。 - -| 代码 | 异常情况 | 理由 | -| ------ | -------------- | -------------------------- | -| 2001 | 触发频率限制 | 小程序启动一定时间内不允许展示插屏广告 | -| 2002 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足，不允许展示插屏广告 | -| 2003 | 触发频率限制 | 当前正在播放激励视频广告或者插屏广告，不允许再次展示插屏广告 | -| 2004 | 广告渲染失败 | 该项错误不是开发者的异常情况，或因小程序页面切换导致广告渲染失败 | -| 2005 | 广告调用异常 | 插屏广告实例不允许跨页面调用 | - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.show.html) - -```tsx -() => Promise -``` - -## 参数 - -### OnCloseCallback - -插屏广告关闭事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnErrorCallback - -插屏错误事件的回调函数 - -```tsx -(result: OnErrorCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnErrorCallbackResult` | - -### OnLoadCallback - -插屏广告加载事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnErrorCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | string or number or symbol | 错误码
[参考地址]( /docs/apis/General#aderrcode) | -| errMsg | `string` | 错误信息 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| InterstitialAd.destroy | ✔️ | | | | -| InterstitialAd.offClose | ✔️ | | | | -| InterstitialAd.offError | ✔️ | | | | -| InterstitialAd.offLoad | ✔️ | | | | -| InterstitialAd.onClose | ✔️ | | | | -| InterstitialAd.onError | ✔️ | | | | -| InterstitialAd.onLoad | ✔️ | | | | -| InterstitialAd.load | ✔️ | | | | -| InterstitialAd.show | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ad/RewardedVideoAd.md b/versioned_docs/version-4.x/apis/ad/RewardedVideoAd.md deleted file mode 100644 index 668ce189707b..000000000000 --- a/versioned_docs/version-4.x/apis/ad/RewardedVideoAd.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: RewardedVideoAd -sidebar_label: RewardedVideoAd ---- - -激励视频广告组件。激励视频广告组件是一个原生组件，层级比普通组件高。激励视频广告是一个单例（小游戏端是全局单例，小程序端是页面内单例，在小程序端的单例对象不允许跨页面使用），默认是隐藏的，需要调用 RewardedVideoAd.show() 将其显示。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.html) - -## 方法 - -### load - -加载激励视频广告。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.load.html) - -```tsx -() => Promise -``` - -### show - -显示激励视频广告。激励视频广告将从屏幕下方推入。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.show.html) - -```tsx -() => Promise -``` - -### destroy - -销毁激励视频广告实例。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.destroy.html) - -```tsx -() => void -``` - -### offClose - -取消监听用户点击 `关闭广告` 按钮的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offClose.html) - -```tsx -(callback: OnCloseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCloseCallback` | - -### offError - -取消监听激励视频错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### offLoad - -取消监听激励视频广告加载事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.offLoad.html) - -```tsx -(callback: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -### onClose - -监听用户点击 `关闭广告` 按钮的事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onClose.html) - -```tsx -(callback: OnCloseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCloseCallback` | - -### onError - -监听激励视频错误事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### onLoad - -监听激励视频广告加载事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/RewardedVideoAd.onLoad.html) - -```tsx -(callback: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -## 参数 - -### OnErrorCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | string or number or symbol | 错误码
[参考地址]( /docs/apis/General#aderrcode) | -| errMsg | `string` | 错误信息 | - -### OnCloseCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isEnded | `boolean` | 视频是否是在用户完整观看的情况下被关闭的 | - -### OnCloseCallback - -用户点击 `关闭广告` 按钮的事件的回调函数 - -```tsx -(result: OnCloseCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnCloseCallbackResult` | - -### OnErrorCallback - -激励视频错误事件的回调函数 - -```tsx -(result: OnErrorCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnErrorCallbackResult` | - -### OnLoadCallback - -激励视频广告加载事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| RewardedVideoAd.load | ✔️ | | | | -| RewardedVideoAd.show | ✔️ | | | | -| RewardedVideoAd.destroy | ✔️ | | | | -| RewardedVideoAd.offClose | ✔️ | | | | -| RewardedVideoAd.offError | ✔️ | | | | -| RewardedVideoAd.offLoad | ✔️ | | | | -| RewardedVideoAd.onClose | ✔️ | | | | -| RewardedVideoAd.onError | ✔️ | | | | -| RewardedVideoAd.onLoad | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ad/createInterstitialAd.md b/versioned_docs/version-4.x/apis/ad/createInterstitialAd.md deleted file mode 100644 index 66b3ef6cef9c..000000000000 --- a/versioned_docs/version-4.x/apis/ad/createInterstitialAd.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.createInterstitialAd(option) -sidebar_label: createInterstitialAd ---- - -创建插屏广告组件。 -请通过 getSystemInfoSync 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例（小程序端的插屏广告实例不允许跨页面使用）。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createInterstitialAd.html) - -## 类型 - -```tsx -(option: Option) => InterstitialAd -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| adUnitId | `string` | 广告单元 id | diff --git a/versioned_docs/version-4.x/apis/ad/createRewardedVideoAd.md b/versioned_docs/version-4.x/apis/ad/createRewardedVideoAd.md deleted file mode 100644 index c3cb27f2181d..000000000000 --- a/versioned_docs/version-4.x/apis/ad/createRewardedVideoAd.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.createRewardedVideoAd(option) -sidebar_label: createRewardedVideoAd ---- - -创建激励视频广告组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/wx.createRewardedVideoAd.html) - -## 类型 - -```tsx -(option: Option) => RewardedVideoAd -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| adUnitId | `string` | | 是 | 小程序广告位 ID
API 支持度: weapp, tt, swan | -| multiton | `boolean` | `false` | 否 | 是否启用多例模式
API 支持度: weapp | -| appSid | `string` | | 否 | 小程序应用 ID
API 支持度: swan
swan: 必填 | diff --git a/versioned_docs/version-4.x/apis/ai/face/faceDetect.md b/versioned_docs/version-4.x/apis/ai/face/faceDetect.md deleted file mode 100644 index 36304c31f970..000000000000 --- a/versioned_docs/version-4.x/apis/ai/face/faceDetect.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Taro.faceDetect(option) -sidebar_label: faceDetect ---- - -人脸识别，使用前需要通过 Taro.initFaceDetect 进行一次初始化，推荐使用相机接口返回的帧数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.faceDetect.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| frameBuffer | `ArrayBuffer` | | 是 | 图像像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | | 是 | 图像宽度 | -| height | `number` | | 是 | 图像高度 | -| enablePoint | `boolean` | `false` | 否 | 是否返回当前图像的人脸（106 个点） | -| enableConf | `boolean` | `false` | 否 | 是否返回当前图像的人脸的置信度（可表示器官遮挡情况） | -| enableAngle | `boolean` | `false` | 否 | 是否返回当前图像的人脸角度信息 | -| enableMultiFace | `boolean` | `false` | 否 | 是否返回多张人脸的信息 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackOption) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| faceInfo | `face` | 否 | 多人模式（enableMultiFace）下的人脸信息，每个对象包含上述其它属性 | - -### face - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| detectRect | `detectRect` | 脸部正方框数值，对象包含 height, weight, originX, originY 四个属性 | -| x | `number` | 脸部中心点横坐标，检测不到人脸则为 -1 | -| y | `number` | 脸部中心点纵坐标，检测不到人脸则为 -1 | -| pointArray | `point[]` | 人脸 106 个点位置数组，数组每个对象包含 x 和 y | -| confArray | `conf[]` | 人脸置信度，取值范围 [0, 1]，数值越大置信度越高（遮挡越少） | -| angleArray | `angle[]` | 人脸角度信息，取值范围 [-1, 1]，数值越接近 0 表示越正对摄像头 | - -### detectRect - -脸部正方框数值 - -| 参数 | 类型 | -| --- | --- | -| height | `number` | -| weight | `number` | -| originX | `number` | -| originY | `number` | - -### point - -| 参数 | 类型 | -| --- | --- | -| x | `number` | -| y | `number` | - -### conf - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| global | `number` | 整体可信度 | -| leftEye | `number` | 左眼可信度 | -| rightEye | `number` | 右眼可信度 | -| mouth | `number` | 嘴巴可信度 | -| nose | `number` | 鼻子可信度 | - -### angle - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| pitch | `number` | 仰俯角（点头） | -| yaw | `number` | 偏航角（摇头） | -| roll | `number` | 翻滚角（左右倾） | diff --git a/versioned_docs/version-4.x/apis/ai/face/initFaceDetect.md b/versioned_docs/version-4.x/apis/ai/face/initFaceDetect.md deleted file mode 100644 index 4068df363f06..000000000000 --- a/versioned_docs/version-4.x/apis/ai/face/initFaceDetect.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.initFaceDetect(option) -sidebar_label: initFaceDetect ---- - -初始化人脸识别 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.initFaceDetect.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ai/face/stopFaceDetect.md b/versioned_docs/version-4.x/apis/ai/face/stopFaceDetect.md deleted file mode 100644 index 62bf2a1a67f2..000000000000 --- a/versioned_docs/version-4.x/apis/ai/face/stopFaceDetect.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.stopFaceDetect(option) -sidebar_label: stopFaceDetect ---- - -停止人脸识别 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/face/wx.stopFaceDetect.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ai/inference/InferenceSession.md b/versioned_docs/version-4.x/apis/ai/inference/InferenceSession.md deleted file mode 100644 index cfc2de4287ca..000000000000 --- a/versioned_docs/version-4.x/apis/ai/inference/InferenceSession.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: InferenceSession -sidebar_label: InferenceSession ---- - -## 方法 - -### destroy - -销毁 InferenceSession 实例 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.destroy.html) - -```tsx -() => void -``` - -### offError - -取消监听模型加载失败事件. 传入指定回调函数则只取消指定回调，不传则取消所有回调 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.offError.html) - -```tsx -(callback?: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### offLoad - -取消监听模型加载完成事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.offLoad.html) - -```tsx -(callback?: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -### onError - -监听模型加载失败事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.onError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### onLoad - -监听模型加载完成事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.onLoad.html) - -```tsx -(callback: OnLoadCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnLoadCallback` | - -### run - -运行推断 -需要在 session.onLoad 回调后使用。接口参数为 Tensors 对象，返回 Promise。 -一个 InferenceSession 被创建完成后可以重复多次调用 InferenceSession.run(), 直到调用 session.destroy() 进行销毁。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/InferenceSession.destroy.html) - -```tsx -(option: Tensors) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Tensors` | - -## 参数 - -### Type - -### Tensor - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| shape | `number[]` | Tensor shape （Tensor 形状，例如 [1, 3, 224, 224] 即表示一个4唯Tensor，每个维度的长度分别为1, 3, 224, 224） | -| data | `ArrayBuffer` | Tensor 值，一段 ArrayBuffer | -| type | `keyof Type` | ArrayBuffer 值的类型，合法值有 uint8, int8, uint32, int32, float32 | - -### Tensors - -| 参数 | 类型 | -| --- | --- | -| __index | `__index` | - -### OnErrorCallback - -模型加载失败回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnLoadCallback - -模型加载完成回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| InferenceSession.destroy | ✔️ | | | | -| InferenceSession.offError | ✔️ | | | | -| InferenceSession.offLoad | ✔️ | | | | -| InferenceSession.onError | ✔️ | | | | -| InferenceSession.onLoad | ✔️ | | | | -| InferenceSession.run | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/inference/createInferenceSession.md b/versioned_docs/version-4.x/apis/ai/inference/createInferenceSession.md deleted file mode 100644 index 8e79df7bd2e6..000000000000 --- a/versioned_docs/version-4.x/apis/ai/inference/createInferenceSession.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.createInferenceSession(option) -sidebar_label: createInferenceSession ---- - -创建 AI 推理 Session - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/wx.createInferenceSession.html) - -## 类型 - -```tsx -(option: Option) => InferenceSession -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| model | `string` | 是 | 模型文件路径，目前只执行后缀为.onnx格式(支持代码包路径，和本地文件系统路径） | -| precesionLevel | `PrecesionLevel` | 否 | 推理精度，有效值为 0 - 4。
一般来说，使用的precesionLevel等级越低，推理速度越快，但可能会损失精度。
推荐开发者在开发时，在效果满足需求时优先使用更低精度以提高推理速度，节约能耗。 | -| allowQuantize | `boolean` | 否 | 是否生成量化模型推理 | -| allowNPU | `boolean` | 否 | 是否使用NPU推理，仅对IOS有效 | -| typicalShape | `boolean` | 否 | 输入典型分辨率 | - -### PrecesionLevel - -| 参数 | 说明 | -| --- | --- | -| 0 | 使用fp16 存储浮点，fp16计算，Winograd 算法也采取fp16 计算，开启近似math计算 | -| 1 | 使用fp16 存储浮点，fp16计算，禁用 Winograd 算法，开启近似math计算 | -| 2 | 使用fp16 存储浮点，fp32计算，开启 Winograd，开启近似math计算 | -| 3 | 使用fp32 存储浮点，fp32计算，开启 Winograd，开启近似math计算 | -| 4 | 使用fp32 存储浮点，fp32计算，开启 Winograd，关闭近似math计算 | diff --git a/versioned_docs/version-4.x/apis/ai/inference/getInferenceEnvInfo.md b/versioned_docs/version-4.x/apis/ai/inference/getInferenceEnvInfo.md deleted file mode 100644 index f8b249b19712..000000000000 --- a/versioned_docs/version-4.x/apis/ai/inference/getInferenceEnvInfo.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.getInferenceEnvInfo(option) -sidebar_label: getInferenceEnvInfo ---- - -获取通用AI推理引擎版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/inference/wx.getInferenceEnvInfo.html) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ver | `string` | AI推理引擎版本 | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKBodyAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKBodyAnchor.md deleted file mode 100644 index 3d8f57a59418..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKBodyAnchor.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: VKBodyAnchor -sidebar_label: VKBodyAnchor ---- - -人体 anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKBodyAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `5` | 类型 | -| detectId | `number` | 识别序号 | -| size | `ISize` | 相对视窗的尺寸，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| origin | `IOrigin` | 相对视窗的位置信息，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| confidence | `number[]` | 关键点的置信度 | -| points | `IPoint[]` | 关键点 | -| score | `number` | 总体置信值 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 5 | 人体 | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### IOrigin - -相对视窗的位置信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -### IPoint - -关键点 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKBodyAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKCamera.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKCamera.md deleted file mode 100644 index b9d413d291f2..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKCamera.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: VKCamera -sidebar_label: VKCamera ---- - -相机对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKCamera.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| viewMatrix | `Float32Array` | 视图矩阵 | -| intrinsics | `Float32Array` | 相机内参，只有 v2 版本支持 | - -### getProjectionMatrix - -获取投影矩阵 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKCamera.getProjectionMatrix.html) - -```tsx -(near: number, far: number) => Float32Array -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| near | `number` | 近视点 | -| far | `number` | 远视点 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKCamera | ✔️ | | | | -| VKCamera.getProjectionMatrix | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKDepthAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKDepthAnchor.md deleted file mode 100644 index 701cc8ce5678..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKDepthAnchor.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: VKDepthAnchor -sidebar_label: VKDepthAnchor ---- - -depth anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKDepthAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `8` | 类型 | -| size | `ISize` | 相对视窗的尺寸，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| depthArray | `number[]` | 包含深度信息的数组 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 8 | DEPTH | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKDepthAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKFaceAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKFaceAnchor.md deleted file mode 100644 index 09d4bc44e7c9..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKFaceAnchor.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: VKFaceAnchor -sidebar_label: VKFaceAnchor ---- - -人脸 anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFaceAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `3` | 类型 | -| detectId | `number` | 识别序号 | -| origin | `IOrigin` | 相对视窗的位置信息，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| size | `ISize` | 相对视窗的尺寸，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| points | `IPoint[]` | 人脸 106 个关键点的坐标 | -| angle | `number[]` | 人脸角度信息 | -| confidence | `number` | 关键点的置信度 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 3 | 人脸 | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### IOrigin - -相对视窗的位置信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -### IPoint - -关键点 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKFaceAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKFrame.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKFrame.md deleted file mode 100644 index d9ae075d9603..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKFrame.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: VKFrame -sidebar_label: VKFrame ---- - -vision kit 会话对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| timestamp | `number` | 生成时间 | -| camera | `VKCamera` | 相机对象 | - -### getCameraTexture - -获取当前帧纹理，目前只支持 YUV 纹理 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.getCameraTexture.html) - -```tsx -(ctx: WebGLRenderingContext) => IGetCameraTextureResult -``` - -| 参数 | 类型 | -| --- | --- | -| ctx | `WebGLRenderingContext` | - -### getCameraBuffer - -获取当前帧 rgba buffer。iOS 端微信在 v8.0.20 开始支持，安卓端微信在 v8.0.30 开始支持。 -按 aspect-fill 规则裁剪，此接口要求在创建 VKSession 对象时必须传入 gl 参数。 -此接口仅建议拿来做帧分析使用，上屏请使用 getCameraTexture 来代替。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.getCameraBuffer.html) - -```tsx -(widht: number, height: number) => ArrayBuffer -``` - -| 参数 | 类型 | -| --- | --- | -| widht | `number` | -| height | `number` | - -### getDisplayTransform - -获取纹理调整矩阵。默认获取到的纹理是未经裁剪调整的纹理，此矩阵可用于在着色器中根据帧对象尺寸对纹理进行裁剪 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKFrame.getDisplayTransform.html) - -```tsx -() => Float32Array -``` - -## 参数 - -### IGetCameraTextureResult - -帧纹理对象 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| yTexture | `WebGLTexture` | Y 分量纹理 | -| uvTexture | `WebGLTexture` | UV 分量纹理 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKFrame | ✔️ | | | | -| VKFrame.getCameraTexture | ✔️ | | | | -| VKFrame.getCameraBuffer | ✔️ | | | | -| VKFrame.getDisplayTransform | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKHandAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKHandAnchor.md deleted file mode 100644 index f19616fa19d9..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKHandAnchor.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: VKHandAnchor -sidebar_label: VKHandAnchor ---- - -手势 anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKHandAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `7` | 类型 | -| detectId | `number` | 识别序号 | -| size | `ISize` | 相对视窗的尺寸，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| origin | `IOrigin` | 相对视窗的位置信息，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| confidence | `number[]` | 关键点的置信度 | -| points | `IPoint[]` | 关键点 | -| score | `number` | 总体置信值 | -| gesture | keyof IGesture or -1 | 手势分类, 返回整数 -1 到 18, -1 表示无效手势 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 7 | 手势 | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### IOrigin - -相对视窗的位置信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -### IPoint - -关键点 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -### IGesture - -手势分类 - -| 参数 | 说明 | -| --- | --- | -| 0 | 单手比心 | -| 1 | 布（数字5） | -| 2 | 剪刀（数字2） | -| 3 | 握拳 | -| 4 | 数字1 | -| 5 | 热爱 | -| 6 | 点赞 | -| 7 | 数字3 | -| 8 | 摇滚 | -| 9 | 数字6 | -| 10 | 数字8 | -| 11 | 双手抱拳（恭喜发财） | -| 12 | 数字4 | -| 13 | 比ok | -| 14 | 不喜欢（踩） | -| 15 | 双手比心 | -| 16 | 祈祷（双手合十） | -| 17 | 双手抱拳 | -| 18 | 无手势动作 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKHandAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKMarkerAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKMarkerAnchor.md deleted file mode 100644 index dcf1a20a161e..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKMarkerAnchor.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: VKMarkerAnchor -sidebar_label: VKMarkerAnchor ---- - -marker anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKMarkerAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `1` | 类型 | -| transform | `Float32Array` | 包含位置、旋转、放缩信息的矩阵，以列为主序 | -| markerId | `number` | marker id | -| path | `string` | 图片路径 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 1 | marker | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKMarkerAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKOCRAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKOCRAnchor.md deleted file mode 100644 index 184694c57878..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKOCRAnchor.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: VKOCRAnchor -sidebar_label: VKOCRAnchor ---- - -OCR anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKOCRAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `6` | 类型 | -| text | `string` | 识别的文字结果 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 6 | OCR | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKOCRAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKOSDAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKOSDAnchor.md deleted file mode 100644 index 2262986e8d21..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKOSDAnchor.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: VKOSDAnchor -sidebar_label: VKOSDAnchor ---- - -OSD anchor - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKOSDAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `2` | 类型 | -| markerId | `number` | marker id | -| size | `ISize` | 相对视窗的尺寸，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | -| path | `string` | 图片路径 | -| origin | `IOrigin` | 相对视窗的位置信息，取值范围为 [0, 1]，0 为左/上边缘，1 为右/下边缘 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 2 | OSD | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### IOrigin - -相对视窗的位置信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 横坐标 | -| y | `number` | 纵坐标 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKOSDAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKPlaneAnchor.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKPlaneAnchor.md deleted file mode 100644 index 70fcb21498e1..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKPlaneAnchor.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: VKPlaneAnchor -sidebar_label: VKPlaneAnchor ---- - -平面 anchor，只有 v2 版本支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKPlaneAnchor.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 唯一标识 | -| type | `0` | 类型 | -| transform | `Float32Array` | 包含位置、旋转、放缩信息的矩阵，以列为主序 | -| size | `ISize` | 尺寸 | -| alignment | `number` | 方向 | - -## 参数 - -### IType - -类型 - -| 参数 | 说明 | -| --- | --- | -| 0 | 平面 | - -### ISize - -相对视窗的尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKPlaneAnchor | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/VKSession.md b/versioned_docs/version-4.x/apis/ai/visionkit/VKSession.md deleted file mode 100644 index e06e8549f380..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/VKSession.md +++ /dev/null @@ -1,664 +0,0 @@ ---- -title: VKSession -sidebar_label: VKSession ---- - -vision kit 会话对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| state | `keyof IState` | 会话状态 | -| config | `IConfig` | 会话配置 | -| cameraSize | `ISize` | 相机尺寸 | - -### addMarker - -添加一个 marker，要求调 Taro.createVKSession 时传入的 track.marker 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.addMarker.html) - -```tsx -(path: string) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| path | `string` | 图片路径，目前只支持本地用户图片 | - -### addOSDMarker - -添加一个 OSD marker（one-shot detection marker），要求调 Taro.createVKSession 时传入的 track.OSD 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.addOSDMarker.html) - -```tsx -(path: string) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| path | `string` | 图片路径，目前只支持本地用户图片 | - -### cancelAnimationFrame - -取消由 requestAnimationFrame 添加到计划中的动画帧请求 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.cancelAnimationFrame.html) - -```tsx -(requestID: number) => void -``` - -| 参数 | 类型 | -| --- | --- | -| requestID | `number` | - -### destroy - -销毁会话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.destroy.html) - -```tsx -() => void -``` - -### detectBody - -静态图像人体关键点检测。当 Taro.createVKSession 参数传入 {track: {body: {mode: 2} } } 时可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.detectBody.html) - -```tsx -(option: IDetectBodyOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IDetectBodyOption` | - -### detectDepth - -深度识别。当 Taro.createVKSession 参数传入 {track: {depth: {mode: 2} } } 时可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.detectDepth.html) - -```tsx -(option: IDetectDepthOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IDetectDepthOption` | - -### detectFace - -静态图像人脸关键点检测。当 Taro.createVKSession 参数传入 {track: {face: {mode: 2} } } 时可用。安卓微信8.0.25开始支持，iOS微信8.0.24开始支持。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.detectFace.html) - -```tsx -(option: IDetectFaceOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IDetectFaceOption` | - -### detectHand - -静态图像手势关键点检测。当 Taro.createVKSession 参数传入 {track: {hand: {mode: 2} } } 时可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.detectHand.html) - -```tsx -(option: IDetectHandOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IDetectHandOption` | - -### getAllMarker - -获取所有 marker，要求调 Taro.createVKSession 时传入的 track.marker 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.getAllMarker.html) - -```tsx -() => IMarker[] -``` - -### getAllOSDMarker - -获取所有 OSD marker，要求调 Taro.createVKSession 时传入的 track.OSD 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.getAllOSDMarker.html) - -```tsx -() => IOSDMarker[] -``` - -### getVKFrame - -获取帧对象，每调用一次都会触发一次帧分析过程 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.getVKFrame.html) - -```tsx -(width: number, height: number) => VKFrame -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### hitTest - -触摸检测，v1 版本只支持单平面（即 hitTest 生成一次平面后，后续 hitTest 均不会再生成平面，而是以之前生成的平面为基础进行检测）。 - -如果需要重新识别其他平面，可以在调用此方法时将 reset 参数置为 true。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.hitTest.html) - -```tsx -(x: number, y: number, reset?: boolean) => IHitTestResult[] -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 相对视窗的横坐标，取值范围为 [0, 1]，0 为左边缘，1 为右边缘 | -| y | `number` | 相对视窗的纵坐标，取值范围为 [0, 1]，0 为上边缘，1 为下边缘 | -| reset | `boolean` | 是否需要重新识别其他平面，v2 版本不再需要此参数 | - -### off - -取消监听会话事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.off.html) - -```tsx -(eventName: string, fn: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| fn | `TaroGeneral.EventCallback` | 事件监听函数 | - -### on - -监听会话事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.on.html) - -```tsx -(eventName: string, fn: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| fn | `TaroGeneral.EventCallback` | 事件监听函数 | - -### removeMarker - -删除一个 marker，要求调 Taro.createVKSession 时传入的 track.marker 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.removeMarker.html) - -```tsx -(markerId: number) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| markerId | `number` | marker id | - -### removeOSDMarker - -删除一个 OSD marker，要求调 Taro.createVKSession 时传入的 track.OSD 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.removeOSDMarker.html) - -```tsx -(markerId: number) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| markerId | `number` | marker id | - -### requestAnimationFrame - -在下次进行重绘时执行。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.requestAnimationFrame.html) - -```tsx -(callback: TaroGeneral.TFunc) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `TaroGeneral.TFunc` | 执行函数 | - -### runOCR - -静态图像 OCR 检测。当 Taro.createVKSession 参数传入 {track: {OCR: {mode: 2} } } 时可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.runOCR.html) - -```tsx -(option: IRunOCROption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IRunOCROption` | - -### start - -开启会话。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.start.html) - -```tsx -(callback: (status: keyof IStartStatus) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(status: keyof IStartStatus) => void` | 开启会话回调 | - -### stop - -停止会话。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.stop.html) - -```tsx -() => void -``` - -### update3DMode - -开启 3D 模式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.update3DMode.html) - -```tsx -(open3d: boolean) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| open3d | `boolean` | 是否开启 | - -### updateOSDThreshold - -更新 OSD 识别精确度，要求调 Taro.createVKSession 时传入的 track.OSD 为 true - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/VKSession.updateOSDThreshold.html) - -```tsx -(threshold: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| threshold | `number` | 阈值 | - -## 参数 - -### IState - -state 的合法值 - -| 参数 | 说明 | -| --- | --- | -| 0 | 不可用 | -| 1 | 运行中 | -| 2 | 暂停中 | -| 3 | 初始化中 | - -### IConfig - -会话配置 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| version | `keyof IVersion` | 不可用 | -| track | `ITrack` | 运行中 | -| marker | `boolean` | marker 跟踪配置，基础库(3.0.0)开始允许同时支持v2的水平面检测能力 | -| OSD | `boolean` | OSD 跟踪配置 | -| depth | `IDepth` | 深度识别配置 | -| face | `IFace` | 人脸检测配置。安卓微信8.0.25开始支持，iOS微信8.0.24开始支持。 | -| OCR | `IOCR` | OCR 检测配置。 | -| body | `IBody` | 人体检测配置。 | -| hand | `IHand` | 手势检测配置。 | -| threeDof | `boolean` | 提供基础AR功能，输出相机旋转的3个自由度的位姿，利用手机陀螺仪传感器，实现快速稳定的AR定位能力，适用于简单AR场景。 | -| gl | `WebGLRenderingContext` | 绑定的 WebGLRenderingContext 对象 | - -### IVersion - -vision kit 版本 - -| 参数 | 说明 | -| --- | --- | -| v1 | 旧版本 | -| v2 | v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 | - -### ITrack - -跟踪配置 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| plane | `IPlane` | 平面跟踪配置 | - -### IPlane - -平面跟踪配置 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mode | `keyof IPlaneMode` | 平面跟踪配置模式 | - -### IPlaneMode - -平面跟踪配置模式合法值 - -| 参数 | 说明 | -| --- | --- | -| 1 | 检测横向平面 | -| 2 | 检测纵向平面，只有 v2 版本支持 | -| 3 | 检测横向和纵向平面，只有 v2 版本支持 | - -### IDepth - -深度识别配置 - -| 参数 | 类型 | -| --- | --- | -| mode | `keyof IDepthMode` | - -### IDepthMode - -深度识别模式 - -| 参数 | 说明 | -| --- | --- | -| 1 | 通过摄像头实时检测 | -| 2 | 静态图片检测 | - -### IFace - -人脸检测模式 - -| 参数 | 类型 | -| --- | --- | -| mode | `keyof IFaceMode` | - -### IFaceMode - -人脸检测模式 - -| 参数 | 说明 | -| --- | --- | -| 1 | 通过摄像头实时检测 | -| 2 | 静态图片检测 | - -### IOCR - -OCR 检测配置 - -| 参数 | 类型 | -| --- | --- | -| mode | `keyof IOCRMode` | - -### IOCRMode - -OCR 检测模式 - -| 参数 | 说明 | -| --- | --- | -| 1 | 通过摄像头实时检测 | -| 2 | 静态图片检测 | - -### IBody - -人体检测模式 - -| 参数 | 类型 | -| --- | --- | -| mode | `keyof IBodyMode` | - -### IBodyMode - -人体检测模式 - -| 参数 | 说明 | -| --- | --- | -| 1 | 通过摄像头实时检测 | -| 2 | 静态图片检测 | - -### IHand - -手势检测配置 - -| 参数 | 类型 | -| --- | --- | -| mode | `keyof IHandMode` | - -### IHandMode - -手势检测模式 - -| 参数 | 说明 | -| --- | --- | -| 1 | 通过摄像头实时检测 | -| 2 | 静态图片检测 | - -### ISize - -相机尺寸 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 宽度 | -| height | `number` | 高度 | - -### IDetectBodyOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| frameBuffer | `ArrayBuffer` | 是 | 人脸图像像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | 是 | 图像宽度 | -| height | `number` | 是 | 图像高度 | -| scoreThreshold | `number` | 否 | 评分阈值。正常情况传入 0.8 即可。默认值 0.8 | -| sourceType | `keyof ISourceType` | 否 | 图像源类型。正常情况传入 1 即可。当输入的图片是来自一个连续视频的每一帧图像时，sourceType 传入 0 会得到更优的效果。默认值1 | - -### ISourceType - -图像源类型。 - -| 参数 | 说明 | -| --- | --- | -| 1 | 表示输入的图片是随机的图片 | -| 0 | 表示输入的图片是来自一个连续视频的每一帧图像 | - -### IDetectDepthOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| frameBuffer | `ArrayBuffer` | 人需要识别深度的图像像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | 图像宽度 | -| height | `number` | 图像高度 | - -### IDetectFaceOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| frameBuffer | `ArrayBuffer` | 是 | 人脸图像像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | 是 | 图像宽度 | -| height | `number` | 是 | 图像高度 | -| scoreThreshold | `number` | 否 | 评分阈值。正常情况传入 0.8 即可。默认值 0.8 | -| sourceType | `keyof ISourceType` | 否 | 图像源类型。正常情况传入 1 即可。当输入的图片是来自一个连续视频的每一帧图像时，sourceType 传入 0 会得到更优的效果。默认值1 | -| modelModel | `keyof IModelModel` | 否 | 算法模型类型。正常情况传入 1 即可。0、1、2 分别表示小、中、大模型，模型越大识别准确率越高，但资源占用也越高。建议根据用户设备性能进行选择。 | - -### IModelModel - -算法模型类型 - -| 参数 | 说明 | -| --- | --- | -| 0 | 小模型 | -| 1 | 中模型 | -| 2 | 大模型 | - -### IDetectHandOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| frameBuffer | `ArrayBuffer` | 是 | 人脸图像像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | 是 | 图像宽度 | -| height | `number` | 是 | 图像高度 | -| scoreThreshold | `number` | 否 | 评分阈值。正常情况传入 0.8 即可。默认值0.8 | -| algoMode | `keyof IAlgoMode` | 否 | 算法检测模式 | - -### IAlgoMode - -算法检测模式 - -| 参数 | 说明 | -| --- | --- | -| 0 | 检测模式，输出框和点 | -| 1 | 手势模式，输出框和手势分类 | -| 2 | 结合0和1模式，输出框、点、手势分类 | - -### IMarker - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| markerId | `number` | marker id | -| path | `string` | 图片路径 | - -### IOSDMarker - -OSD marker - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| markerId | `number` | marker id | -| path | `string` | 图片路径 | - -### IRunOCROption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| frameBuffer | `ArrayBuffer` | 待识别图像的像素点数据，每四项表示一个像素点的 RGBA | -| width | `number` | 图像宽度 | -| height | `number` | 图像高度 | - -### IHitTestResult - -hitTest 检测结果 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| transform | `Float32Array` | 包含位置、旋转、放缩信息的矩阵，以列为主序 | - -### IStartStatus - -start status 的合法值 - -| 参数 | 说明 | -| --- | --- | -| 0 | 成功 | -| 2000000 | 系统错误 | -| 2000001 | 参数错误 | -| 2000002 | 设备不支持 | -| 2000003 | 系统不支持 | -| 2003000 | 会话不可用 | -| 2003001 | 未开启系统相机权限 | -| 2003002 | 未开启小程序相机权限 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VKSession | ✔️ | | | | -| VKSession.addMarker | ✔️ | | | | -| VKSession.addOSDMarker | ✔️ | | | | -| VKSession.cancelAnimationFrame | ✔️ | | | | -| VKSession.destroy | ✔️ | | | | -| VKSession.detectBody | ✔️ | | | | -| VKSession.detectDepth | ✔️ | | | | -| VKSession.detectFace | ✔️ | | | | -| VKSession.detectHand | ✔️ | | | | -| VKSession.getAllMarker | ✔️ | | | | -| VKSession.getAllOSDMarker | ✔️ | | | | -| VKSession.getVKFrame | ✔️ | | | | -| VKSession.hitTest | ✔️ | | | | -| VKSession.off | ✔️ | | | | -| VKSession.on | ✔️ | | | | -| VKSession.removeMarker | ✔️ | | | | -| VKSession.removeOSDMarker | ✔️ | | | | -| VKSession.requestAnimationFrame | ✔️ | | | | -| VKSession.runOCR | ✔️ | | | | -| VKSession.start | ✔️ | | | | -| VKSession.stop | ✔️ | | | | -| VKSession.update3DMode | ✔️ | | | | -| VKSession.updateOSDThreshold | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/createVKSession.md b/versioned_docs/version-4.x/apis/ai/visionkit/createVKSession.md deleted file mode 100644 index fa5fa1fb8c28..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/createVKSession.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.createVKSession(version) -sidebar_label: createVKSession ---- - -创建 vision kit 会话对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/wx.createVKSession.html) - -## 类型 - -```tsx -(version: keyof IVersion) => VKSession -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| version | `keyof IVersion` | - -### IVersion - -vision kit 版本 - -| 参数 | 说明 | -| --- | --- | -| v1 | 旧版本 | -| v2 | v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 | - -### ITrack - -跟踪配置 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| plane | `IPlane` | 平面跟踪配置 | - -### IPlane - -平面跟踪配置 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mode | `keyof IPlaneMode` | 平面跟踪配置模式 | - -### IPlaneMode - -平面跟踪配置模式合法值 - -| 参数 | 说明 | -| --- | --- | -| 1 | 检测横向平面 | -| 2 | 检测纵向平面，只有 v2 版本支持 | -| 3 | 检测横向和纵向平面，只有 v2 版本支持 | diff --git a/versioned_docs/version-4.x/apis/ai/visionkit/isVKSupport.md b/versioned_docs/version-4.x/apis/ai/visionkit/isVKSupport.md deleted file mode 100644 index 144da2a59213..000000000000 --- a/versioned_docs/version-4.x/apis/ai/visionkit/isVKSupport.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.isVKSupport(version) -sidebar_label: isVKSupport ---- - -判断支持版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ai/visionkit/wx.isVKSupport.html) - -## 类型 - -```tsx -(version: keyof IVersion) => boolean -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| version | `keyof IVersion` | - -### IVersion - -vision kit 版本 - -| 参数 | 说明 | -| --- | --- | -| v1 | 旧版本 | -| v2 | v2 版本，目前只有 iOS 基础库 2.22.0 以上支持 | diff --git a/versioned_docs/version-4.x/apis/alipay/getOpenUserInfo.md b/versioned_docs/version-4.x/apis/alipay/getOpenUserInfo.md deleted file mode 100644 index 42f4320836a7..000000000000 --- a/versioned_docs/version-4.x/apis/alipay/getOpenUserInfo.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.getOpenUserInfo(Option) -sidebar_label: getOpenUserInfo ---- - -此接口可获取支付宝会员的基础信息（头像图片地址、昵称、性别、国家码、省份、所在市区），接入方法请参考 获取会员基础信息介绍。如需获取支付宝会员标识（user_id），请调用 my.getAuthCode 和 alipay.system.oauth.token 接口。 - -支持情况： - -> [参考文档](https://docs.alipay.com/mini/api/ch8chh) - -## 类型 - -```tsx -(Option: Option) => Promise -``` - -## 参数 - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| response | `string` | 返回一个 Object 类型的对象 res。使用 JSON.parse(res.response).response 解析 | diff --git a/versioned_docs/version-4.x/apis/alipay/tradePay.md b/versioned_docs/version-4.x/apis/alipay/tradePay.md deleted file mode 100644 index 5c44204660a6..000000000000 --- a/versioned_docs/version-4.x/apis/alipay/tradePay.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.tradePay(Option) -sidebar_label: tradePay ---- - -此接口是用于发起支付的 API，此 API 暂仅支持企业支付宝小程序使用 - -支持情况： - -> [参考文档](https://opendocs.alipay.com/mini/api/openapi-pay) - -## 类型 - -```tsx -(Option: Option) => Promise -``` - -## 参数 - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tradeNO | `string` | 否 | 接入小程序支付时传入此参数。此参数为支付宝交易号，注意参数有大小写区分（调用 小程序支付 时必填） | -| orderStr | `string` | 否 | 完整的支付参数拼接成的字符串，从服务端获取（调用 支付宝预授权 时必填） | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### ResultCode - -| 参数 | 说明 | -| --- | --- | -| 4 | 无权限调用（N22104） | -| 9000 | 订单处理成功 | -| 8000 | 正在处理中。支付结果未知（有可能已经支付成功） | -| 4000 | 订单处理失败 | -| 6001 | 用户中途取消 | -| 6002 | 网络连接出错 | -| 6004 | 处理结果未知（有可能已经成功） | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| response | `{ resultCode: ResultCode; }` | success 回调函数会携带一个 Object 类型的对象，其属性如下： | diff --git a/versioned_docs/version-4.x/apis/base/arrayBufferToBase64.md b/versioned_docs/version-4.x/apis/base/arrayBufferToBase64.md deleted file mode 100644 index 58dd07ff7a11..000000000000 --- a/versioned_docs/version-4.x/apis/base/arrayBufferToBase64.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.arrayBufferToBase64(buffer) -sidebar_label: arrayBufferToBase64 ---- - -将 ArrayBuffer 数据转成 Base64 字符串。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.arrayBufferToBase64.html) - -## 类型 - -```tsx -(buffer: ArrayBuffer) => string -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| buffer | `ArrayBuffer` | 要转换成 Base64 字符串的 ArrayBuffer 对象 | - -## 示例代码 - -```tsx -const arrayBuffer = new Uint8Array([11, 22, 33]) -const base64 = Taro.arrayBufferToBase64(arrayBuffer) -``` diff --git a/versioned_docs/version-4.x/apis/base/base64ToArrayBuffer.md b/versioned_docs/version-4.x/apis/base/base64ToArrayBuffer.md deleted file mode 100644 index 39e92a9f44f8..000000000000 --- a/versioned_docs/version-4.x/apis/base/base64ToArrayBuffer.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.base64ToArrayBuffer(base64) -sidebar_label: base64ToArrayBuffer ---- - -将 Base64 字符串转成 ArrayBuffer 数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.base64ToArrayBuffer.html) - -## 类型 - -```tsx -(base64: string) => ArrayBuffer -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| base64 | `string` | 要转化成 ArrayBuffer 对象的 Base64 字符串 | - -## 示例代码 - -```tsx -const base64 = 'CxYh' -const arrayBuffer = Taro.base64ToArrayBuffer(base64) -``` diff --git a/versioned_docs/version-4.x/apis/base/canIUse.md b/versioned_docs/version-4.x/apis/base/canIUse.md deleted file mode 100644 index d83c01d5ae8b..000000000000 --- a/versioned_docs/version-4.x/apis/base/canIUse.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.canIUse(schema) -sidebar_label: canIUse ---- - -判断小程序的 API，回调，参数，组件等是否在当前版本可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.canIUse.html) - -## 类型 - -```tsx -(schema: string) => boolean -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| schema | `string` | 使用 `${API}.${method}.${param}.${option}` 或者 `${component}.${attribute}.${option}` 方式来调用

**参数说明**

- `${API}` 代表 API 名字
- `${method}` 代表调用方式，有效值为return, success, object, callback
- `${param}` 代表参数或者返回值
- `${option}` 代表参数的可选值或者返回值的属性
- `${component}` 代表组件名字
- `${attribute}` 代表组件属性
- `${option}` 代表组件属性的可选值 | - -## 示例代码 - -```tsx -Taro.canIUse('openBluetoothAdapter') -Taro.canIUse('getSystemInfoSync.return.screenWidth') -Taro.canIUse('getSystemInfo.success.screenWidth') -Taro.canIUse('showToast.object.image') -Taro.canIUse('onCompassChange.callback.direction') -Taro.canIUse('request.object.method.GET') -Taro.canIUse('live-player') -Taro.canIUse('text.selectable') -Taro.canIUse('button.open-type.contact') -``` diff --git a/versioned_docs/version-4.x/apis/base/canIUseWebp.md b/versioned_docs/version-4.x/apis/base/canIUseWebp.md deleted file mode 100644 index 58441f957933..000000000000 --- a/versioned_docs/version-4.x/apis/base/canIUseWebp.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.canIUseWebp() -sidebar_label: canIUseWebp ---- - -判断能否使用 WebP 格式 - -> 在小程序平台中仅在 android 和 devtools 设备时可用 - -支持情况： - -## 类型 - -```tsx -() => boolean -``` diff --git a/versioned_docs/version-4.x/apis/base/crypto/UserCryptoManager.md b/versioned_docs/version-4.x/apis/base/crypto/UserCryptoManager.md deleted file mode 100644 index ee0da7927e33..000000000000 --- a/versioned_docs/version-4.x/apis/base/crypto/UserCryptoManager.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: UserCryptoManager -sidebar_label: UserCryptoManager ---- - -用户加密模块 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.html) - -## 方法 - -### getLatestUserKey - -获取最新的用户加密密钥 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getLatestUserKey.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -#### 示例代码 - -```tsx -const userCryptoManager = Taro.getUserCryptoManager() -userCryptoManager.getLatestUserKey({ - success: res => { - const { encryptKey, iv, version, expireTime } = res - console.log(encryptKey, iv, version, expireTime) - } -}) -``` - -### getRandomValues - -获取密码学安全随机数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getRandomValues.html) - -```tsx -(option: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -#### 示例代码 - -```tsx -Taro.getUserCryptoManager().getRandomValues({ - length: 6 // 生成 6 个字节长度的随机数, - success: res => { - console.log(Taro.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印 - } -}) -``` - -## 参数 - -### getLatestUserKey - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: SuccessCallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| encryptKey | `string` | 用户加密密钥 | -| iv | `string` | 密钥初始向量 | -| version | `number` | 密钥版本 | -| expireTime | `number` | 密钥过期时间 | - -### getRandomValues - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| length | `number` | 是 | 整数，生成随机数的字节数，最大 1048576 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: SuccessCallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| randomValues | `ArrayBuffer` | 随机数内容，长度为传入的字节数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| UserCryptoManager | ✔️ | | | | -| UserCryptoManager.getLatestUserKey | ✔️ | | | | -| UserCryptoManager.getRandomValues | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/crypto/getRandomValues.md b/versioned_docs/version-4.x/apis/base/crypto/getRandomValues.md deleted file mode 100644 index 188ac6dd845a..000000000000 --- a/versioned_docs/version-4.x/apis/base/crypto/getRandomValues.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.getRandomValues(option) -sidebar_label: getRandomValues ---- - -获取密码学安全随机数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/UserCryptoManager.getRandomValues.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 示例代码 - -```tsx -Taro.getRandomValues({ - length: 6 // 生成 6 个字节长度的随机数 -}).then(res => { - console.log(Taro.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印 -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/crypto/getUserCryptoManager.md b/versioned_docs/version-4.x/apis/base/crypto/getUserCryptoManager.md deleted file mode 100644 index 83f1ae4d908c..000000000000 --- a/versioned_docs/version-4.x/apis/base/crypto/getUserCryptoManager.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.getUserCryptoManager() -sidebar_label: getUserCryptoManager ---- - -获取用户加密模块 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/crypto/wx.getUserCryptoManager.html) - -## 类型 - -```tsx -() => UserCryptoManager -``` diff --git a/versioned_docs/version-4.x/apis/base/debug/LogManager.md b/versioned_docs/version-4.x/apis/base/debug/LogManager.md deleted file mode 100644 index f435f4d9d5cc..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/LogManager.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: LogManager -sidebar_label: LogManager ---- - -日志管理器实例，可以通过 Taro.getLogManager 获取。 - -使用说明 -最多保存5M的日志内容，超过5M后，旧的日志内容会被删除。 -对于小程序，用户可以通过使用 button 组件的 open-type="feedback" 来上传打印的日志。 -对于小游戏，用户可以通过使用 Taro.createFeedbackButton 来创建上传打印的日志的按钮。 -开发者可以通过小程序管理后台左侧菜单“反馈管理”页面查看相关打印日志。 - -基础库默认会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/LogManager.html) - -## 方法 - -### debug - -写 debug 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/LogManager.debug.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过100Kb | - -### info - -写 info 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/LogManager.info.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过100Kb | - -### log - -写 log 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/LogManager.log.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过100Kb | - -### warn - -写 warn 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/LogManager.warn.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过100Kb | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| LogManager | ✔️ | | | | -| LogManager.debug | ✔️ | | | | -| LogManager.info | ✔️ | | | | -| LogManager.log | ✔️ | | | | -| LogManager.warn | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/debug/RealtimeLogManager.md b/versioned_docs/version-4.x/apis/base/debug/RealtimeLogManager.md deleted file mode 100644 index 09ec89b0438d..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/RealtimeLogManager.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: RealtimeLogManager -sidebar_label: RealtimeLogManager ---- - -实时日志管理器实例，可以通过 Taro.getRealtimeLogManager 获取。 - -使用说明 -为帮助小程序开发者快捷地排查小程序漏洞、定位问题，我们推出了实时日志功能。从基础库2.7.1开始，开发者可通过提供的接口打印日志，日志汇聚并实时上报到小程序后台。 -开发者可从小程序管理后台“开发->运维中心->实时日志”进入日志查询页面，查看开发者打印的日志信息。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.html) - -## 方法 - -### addFilterMsg - -添加过滤关键字 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.addFilterMsg.html) - -```tsx -(msg: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| msg | `string` | 是 setFilterMsg 的添加接口。用于设置多个过滤关键字。 | - -### error - -写 error 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.error.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过5Kb | - -### in - -设置实时日志page参数所在的页面 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.in.html) - -```tsx -(pageInstance: any) => void -``` - -| 参数 | 说明 | -| --- | --- | -| pageInstance | page 实例 | - -### info - -写 info 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.info.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过5Kb | - -### setFilterMsg - -设置过滤关键字 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.setFilterMsg.html) - -```tsx -(msg: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| msg | `string` | 过滤关键字，最多不超过1Kb，可以在小程序管理后台根据设置的内容搜索得到对应的日志。 | - -### tag - -获取给定标签的日志管理器实例，目前只支持在插件使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.tag.html) - -```tsx -(tagName: string) => RealtimeTagLogManager -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tagName | `string` | 标签名 | - -### warn - -写 warn 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeLogManager.warn.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。每次调用的参数的总大小不超过5Kb | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| RealtimeLogManager | ✔️ | | | | -| RealtimeLogManager.addFilterMsg | ✔️ | | | | -| RealtimeLogManager.error | ✔️ | | | | -| RealtimeLogManager.in | ✔️ | | | | -| RealtimeLogManager.info | ✔️ | | | | -| RealtimeLogManager.setFilterMsg | ✔️ | | | | -| RealtimeLogManager.tag | ✔️ | | | | -| RealtimeLogManager.warn | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/debug/RealtimeTagLogManager.md b/versioned_docs/version-4.x/apis/base/debug/RealtimeTagLogManager.md deleted file mode 100644 index 03df5b47a8ef..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/RealtimeTagLogManager.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: RealtimeTagLogManager -sidebar_label: RealtimeTagLogManager ---- - -给定标签的实时日志管理器实例，可以通过 给定标签的实时日志管理器实例，可以通过 [RealtimeLogManager.tag](./RealtimeLogManager#tag) 接口获取，目前只支持在插件使用。 接口获取，目前只支持在插件使用。 - -**使用说明** -RealtimeTagLogManager 功能和 [RealtimeLogManager](./RealtimeLogManager) 相似，但是为了让输出的实时日志更易于分析，其具有更严格的格式要求。 -RealtimeTagLogManager 使用时需要传入标签，调用该实例所输出的日志均会被汇集到对应标签下，同时该实例的日志只支持 key-value 格式进行输出。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.html) - -## 方法 - -### addFilterMsg - -添加过滤关键字 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.addFilterMsg.html) - -```tsx -(msg: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| msg | `string` | 是 setFilterMsg 的添加接口。用于设置多个过滤关键字。 | - -### error - -写 error 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.error.html) - -```tsx -(key: string, value: string | number | Object | any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | 日志的 key | -| value | string or number or Object or any[] | 日志的 key | - -### info - -写 info 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.info.html) - -```tsx -(key: string, value: string | number | Object | any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | 日志的 key | -| value | string or number or Object or any[] | 日志的 key | - -### setFilterMsg - -设置过滤关键字 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.setFilterMsg.html) - -```tsx -(msg: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| msg | `string` | 过滤关键字，最多不超过1Kb，可以在小程序管理后台根据设置的内容搜索得到对应的日志。 | - -### warn - -写 warn 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/RealtimeTagLogManager.warn.html) - -```tsx -(key: string, value: string | number | Object | any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | 日志的 key | -| value | string or number or Object or any[] | 日志的 key | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| RealtimeTagLogManager | ✔️ | | | | -| RealtimeTagLogManager.addFilterMsg | ✔️ | | | | -| RealtimeTagLogManager.error | ✔️ | | | | -| RealtimeTagLogManager.info | ✔️ | | | | -| RealtimeTagLogManager.setFilterMsg | ✔️ | | | | -| RealtimeTagLogManager.warn | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/debug/console.md b/versioned_docs/version-4.x/apis/base/debug/console.md deleted file mode 100644 index bfa70032e1d3..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/console.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: console -sidebar_label: console ---- - -向调试面板中打印日志。console 是一个全局对象，可以直接访问。在微信客户端中，向 vConsole 中输出日志。 - -**注意** -- 由于 vConsole 功能有限，以及不同客户端对 console 方法的支持情况有差异，建议开发者在小程序中只使用本文档中提供的方法。 -- 部分内容展示的限制请参见调试 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.html) - -## 方法 - -### debug - -向调试面板中打印 debug 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.debug.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。 | - -### error - -向调试面板中打印 error 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.error.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。 | - -### group - -在调试面板中创建一个新的分组 - -**注意** -仅在工具中有效，在 vConsole 中为空函数实现。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.group.html) - -```tsx -(label?: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| label | `string` | 分组标记 | - -### groupEnd - -结束由 [console.group](#group) 创建的分组 - -**注意** -仅在工具中有效，在 vConsole 中为空函数实现。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.groupEnd.html) - -```tsx -() => void -``` - -### info - -向调试面板中打印 info 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.info.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。 | - -### log - -向调试面板中打印 log 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.log.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。 | - -### warn - -向调试面板中打印 warn 日志 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/console.warn.html) - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| args | `any[]` | 日志内容，可以有任意多个。 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| console | ✔️ | | | | | -| console.debug | ✔️ | | | | | -| console.error | ✔️ | | | | | -| console.group | ✔️ | | | | | -| console.groupEnd | ✔️ | | | | | -| console.info | ✔️ | | | | | -| console.log | ✔️ | ✔️ | | | | -| console.warn | ✔️ | | | | | diff --git a/versioned_docs/version-4.x/apis/base/debug/getLogManager.md b/versioned_docs/version-4.x/apis/base/debug/getLogManager.md deleted file mode 100644 index 3276fe890d27..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/getLogManager.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.getLogManager(res) -sidebar_label: getLogManager ---- - -获取日志管理器对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.getLogManager.html) - -## 类型 - -```tsx -(res?: Option) => LogManager -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | -| --- | --- | :---: | :---: | -| level | `keyof Level` | `0` | 否 | - -### Level - -| 参数 | 说明 | -| --- | --- | -| 0 | 表示会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志 | -| 1 | 表示不会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志 | - -## 示例代码 - -```tsx -const logger = Taro.getLogManager({level: 1}) - -logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3]) -logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3]) -logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3]) -logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3]) -``` diff --git a/versioned_docs/version-4.x/apis/base/debug/getRealtimeLogManager.md b/versioned_docs/version-4.x/apis/base/debug/getRealtimeLogManager.md deleted file mode 100644 index 7af34fc7f915..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/getRealtimeLogManager.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Taro.getRealtimeLogManager() -sidebar_label: getRealtimeLogManager ---- - -获取实时日志管理器对象。 - -支持情况： - -## 类型 - -```tsx -() => RealtimeLogManager -``` - -## 示例代码 - -```tsx -const logger = Taro.getRealtimeLogManager() -logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3]) -logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3]) -logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3]) -``` diff --git a/versioned_docs/version-4.x/apis/base/debug/setEnableDebug.md b/versioned_docs/version-4.x/apis/base/debug/setEnableDebug.md deleted file mode 100644 index 7ce22b8e676f..000000000000 --- a/versioned_docs/version-4.x/apis/base/debug/setEnableDebug.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.setEnableDebug(res) -sidebar_label: setEnableDebug ---- - -设置是否打开调试开关，此开关对正式版也能生效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.setEnableDebug.html) - -## 类型 - -```tsx -(res: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| enableDebug | `boolean` | 是 | 是否打开调试 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -// 打开调试 -Taro.setEnableDebug({ - enableDebug: true -}) -// 关闭调试 -Taro.setEnableDebug({ - enableDebug: false -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/env.md b/versioned_docs/version-4.x/apis/base/env.md deleted file mode 100644 index bdba603da6ae..000000000000 --- a/versioned_docs/version-4.x/apis/base/env.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: env -sidebar_label: env ---- - -环境变量 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/wx.env.html) - -## 类型 - -```tsx -TaroGeneral.IAnyObject -``` diff --git a/versioned_docs/version-4.x/apis/base/env/env.md b/versioned_docs/version-4.x/apis/base/env/env.md deleted file mode 100644 index 74c5e61622ab..000000000000 --- a/versioned_docs/version-4.x/apis/base/env/env.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: env -sidebar_label: env ---- - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/env/envObj.html) - -## 类型 - -```tsx -{ [key: string]: string; FRAMEWORK: "react" | "preact" | "nerv" | "vue" | "vue3"; TARO_ENV: "weapp" | "h5" | "rn" | "swan" | "alipay" | "tt" | "qq" | "jd" | "quickapp"; USER_DATA_PATH?: string; } -``` diff --git a/versioned_docs/version-4.x/apis/base/performance/EntryList.md b/versioned_docs/version-4.x/apis/base/performance/EntryList.md deleted file mode 100644 index 7c7bd5737b8b..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/EntryList.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: EntryList -sidebar_label: EntryList ---- - -EntryList 对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/EntryList.html) - -## 方法 - -### getEntries - -该方法返回当前列表中的所有性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/EntryList.getEntries.html) - -```tsx -() => PerformanceEntry[] -``` - -### getEntriesByName - -获取当前列表中所有名称为 [name] 且类型为 [entryType] 的性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/EntryList.getEntriesByName.html) - -```tsx -(name: string, entryType: string) => PerformanceEntry[] -``` - -| 参数 | 类型 | -| --- | --- | -| name | `string` | -| entryType | `string` | - -### getEntriesByType - -获取当前列表中所有类型为 [entryType] 的性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/EntryList.getEntriesByType.html) - -```tsx -(entryType: string) => PerformanceEntry[] -``` - -| 参数 | 类型 | -| --- | --- | -| entryType | `string` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| EntryList | ✔️ | | | | -| EntryList.getEntries | ✔️ | | | | -| EntryList.getEntriesByName | ✔️ | | | | -| EntryList.getEntriesByType | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/performance/Performance.md b/versioned_docs/version-4.x/apis/base/performance/Performance.md deleted file mode 100644 index c3f4c49c33b1..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/Performance.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Performance -sidebar_label: Performance ---- - -Performance 对象，用于获取性能数据及创建性能监听器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.html) - -## 方法 - -### createObserver - -创建全局性能事件监听器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.createObserver.html) - -```tsx -(callback: TaroGeneral.TFunc) => PerformanceObserver -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `TaroGeneral.TFunc` | - -### getEntries - -该方法返回当前缓冲区中的所有性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.getEntries.html) - -```tsx -() => PerformanceEntry[] -``` - -### getEntriesByName - -获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.getEntriesByName.html) - -```tsx -(name: string, entryType: string) => PerformanceEntry[] -``` - -| 参数 | 类型 | -| --- | --- | -| name | `string` | -| entryType | `string` | - -### getEntriesByType - -获取当前缓冲区中所有类型为 [entryType] 的性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.getEntriesByType.html) - -```tsx -(entryType: string) => PerformanceEntry[] -``` - -| 参数 | 类型 | -| --- | --- | -| entryType | `string` | - -### setBufferSize - -设置缓冲区大小，默认缓冲 30 条性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/Performance.setBufferSize.html) - -```tsx -(size: number) => void -``` - -| 参数 | 类型 | -| --- | --- | -| size | `number` | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| Performance | ✔️ | ✔️ | | | | -| Performance.createObserver | ✔️ | | | | | -| Performance.getEntries | ✔️ | ✔️ | | | | -| Performance.getEntriesByName | ✔️ | ✔️ | | | | -| Performance.getEntriesByType | ✔️ | ✔️ | | | | -| Performance.setBufferSize | ✔️ | | | | | diff --git a/versioned_docs/version-4.x/apis/base/performance/PerformanceEntry.md b/versioned_docs/version-4.x/apis/base/performance/PerformanceEntry.md deleted file mode 100644 index bbfec5d15281..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/PerformanceEntry.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: PerformanceEntry -sidebar_label: PerformanceEntry ---- - -单条性能数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/PerformanceEntry.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| entryType | `keyof EntryType` | 指标类型 | -| name | `keyof EntryName` | 指标名称 | -| startTime | `number` | 开始时间，不同指标的具体含义会有差异 | -| duration | `number` | 耗时 ms。仅对于表示阶段的指标有效。 | -| path | `string` | 页面路径。仅 render 和 navigation 类型指标有效。 | -| navigationStart | `number` | 路由真正响应开始时间。仅 navigation 类型指标有效。 | -| navigationType | `string` | 路由详细类型，与小程序路由方法对应。仅 navigation 类型指标有效。 | -| moduleName | `string` | 分包名，主包表示为 APP。仅 evaluateScript 指标有效。 | -| fileList | `string[]` | 注入文件列表。仅 evaluateScript 指标有效。 | -| viewLayerReadyTime | `number` | 渲染层代码注入完成时间。仅 firstRender 指标有效。 | -| initDataSendTime | `number` | 首次渲染参数从逻辑层发出的时间。仅 firstRender 指标有效。 | -| initDataRecvTime | `number` | 首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。 | -| viewLayerRenderStartTime | `number` | 渲染层执行渲染开始时间。仅 firstRender 指标有效。 | -| viewLayerRenderEndTime | `number` | 渲染层执行渲染结束时间。仅 firstRender 指标有效。 | - -## 参数 - -### EntryType - -entryType 的合法值 - -| 参数 | 说明 | -| --- | --- | -| navigation | 路由 | -| render | 渲染 | -| script | 脚本 | - -### EntryName - -name 的合法值 - -| 参数 | 说明 | -| --- | --- | -| appLaunch | 小程序启动耗时。起点为用户点击小程序图标，或小程序被拉起的时间；终点为首页 onReady。(entryType: navigation) | -| route | 路由处理耗时。(entryType: navigation) | -| firstRender | 页面首次渲染耗时。起点为逻辑层收到路由事件，包括逻辑层页面与组件初始化、VD 同步、渲染层执行渲染的时间；终点为首页 onReady。(entryType: render) | -| firstPaint | [页面首次绘制](https://developer.mozilla.org/en-US/docs/Glossary/First_paint)。第一个像素渲染到屏幕上所用的时间。(entryType: render) | -| firstContentfulPaint | [页面首次内容绘制](https://developer.mozilla.org/en-US/docs/Glossary/First_contentful_paint)。第一块内容渲染到屏幕上所用的时间。(entryType: render) | -| evaluateScript | 逻辑层 JS 代码注入耗时。(entryType: script) | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| PerformanceEntry | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/performance/PerformanceObserver.md b/versioned_docs/version-4.x/apis/base/performance/PerformanceObserver.md deleted file mode 100644 index 429369332d38..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/PerformanceObserver.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: PerformanceObserver -sidebar_label: PerformanceObserver ---- - -PerformanceObserver 对象，用于监听性能相关事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/PerformanceObserver.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| supportedEntryTypes | `PerformanceEntry[]` | 获取当前支持的所有性能指标类型 | - -### disconnect - -停止监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/PerformanceObserver.disconnect.html) - -```tsx -() => void -``` - -### observe - -开始监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/PerformanceObserver.observe.html) - -```tsx -(option: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### observe - -#### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `keyof EntryType` | 指标类型。不能和 entryTypes 同时使用 | -| entryTypes | `(keyof EntryType)[]` | 指标类型列表。不能和 type 同时使用。 | - -#### EntryType - -| 参数 | 说明 | -| --- | --- | -| navigation | 路由 | -| render | 渲染 | -| script | 脚本 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| PerformanceObserver | ✔️ | | | | -| PerformanceObserver.disconnect | ✔️ | | | | -| PerformanceObserver.observe | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/performance/getPerformance.md b/versioned_docs/version-4.x/apis/base/performance/getPerformance.md deleted file mode 100644 index 1b41b0d51b75..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/getPerformance.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.getPerformance() -sidebar_label: getPerformance ---- - -小程序测速上报。使用前，需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/index.html)指南。 - -**注意** -- 目前，当开启代码 [按需注入](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/lazyload.html) `时，evaluateScript` 将仅包含公有部分代码，页面和组件的代码注入的时间会包含在 `firstRender` 中（因为页面和组件的代码注入过程成为了首次渲染过程的一部分）。因此开启按需注入后，脚本耗时降低，渲染时间提高属于正常现象，优化效果可以关注整体启动耗时（`appLaunch`）来评估。 -- `firstPaint` 和 `firstContentfulPaint` 指标在开启 `vconsole` 的情况下，由于绘制 `vconsoel` 的面板，会导致数据提前。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.getPerformance.html) - -## 类型 - -```tsx -() => Performance -``` - -## 示例代码 - -```tsx -const performance = Taro.getPerformance() -const observer = performance.createObserver((entryList) => { - console.log(entryList.getEntries()) -}) -observer.observe({ entryTypes: ['render', 'script', 'navigation'] }) -``` diff --git a/versioned_docs/version-4.x/apis/base/performance/preloadAssets.md b/versioned_docs/version-4.x/apis/base/performance/preloadAssets.md deleted file mode 100644 index d90380f1d75e..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/preloadAssets.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.preloadAssets(option) -sidebar_label: preloadAssets ---- - -为视图层预加载媒体资源文件, 目前支持：font，image - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadAssets.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### AssetsObjectType - -| 参数 | 说明 | -| --- | --- | -| font | 字体 | -| image | 图片 | - -### AssetsObject - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `keyof AssetsObjectType` | 类型 | -| src | `string` | 资源地址 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `AssetsObjectType[]` | 是 | | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/performance/preloadSkylineView.md b/versioned_docs/version-4.x/apis/base/performance/preloadSkylineView.md deleted file mode 100644 index 668ed99a1e49..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/preloadSkylineView.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.preloadSkylineView(option) -sidebar_label: preloadSkylineView ---- - -预加载下个页面所需要的 Skyline 运行环境 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadSkylineView.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/performance/preloadWebview.md b/versioned_docs/version-4.x/apis/base/performance/preloadWebview.md deleted file mode 100644 index e2d2a37bb0e9..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/preloadWebview.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.preloadWebview(option) -sidebar_label: preloadWebview ---- - -预加载下个页面的 WebView - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.preloadWebview.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/performance/reportPerformance.md b/versioned_docs/version-4.x/apis/base/performance/reportPerformance.md deleted file mode 100644 index b933daf4aebf..000000000000 --- a/versioned_docs/version-4.x/apis/base/performance/reportPerformance.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.reportPerformance(id, value, dimensions) -sidebar_label: reportPerformance ---- - -小程序测速上报。使用前，需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/index.html)指南。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/performance/wx.reportPerformance.html) - -## 类型 - -```tsx -(id: number, value: number, dimensions?: string | string[]) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 指标 id | -| value | `number` | 需要上报的数值 | -| dimensions | string or string[] | 自定义维度 | - -## 示例代码 - -```tsx -Taro.reportPerformance(1101, 680) -Taro.reportPerformance(1101, 680, 'custom') -``` diff --git a/versioned_docs/version-4.x/apis/base/preload.md b/versioned_docs/version-4.x/apis/base/preload.md deleted file mode 100644 index 637fa48b808a..000000000000 --- a/versioned_docs/version-4.x/apis/base/preload.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.preload(options) -sidebar_label: preload ---- - -跳转预加载 API - -## 类型 - -```tsx -{ (options: Record): any; (key: string, value: any): any; } -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| options | `Record` | 预加载的数据
param: options 预加载的数据 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.preload({ key: 'value' }) -``` - -### 示例 2 - -```tsx -Taro.preload('key', 'value') -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getAppAuthorizeSetting.md b/versioned_docs/version-4.x/apis/base/system/getAppAuthorizeSetting.md deleted file mode 100644 index 959bd67b3f3e..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getAppAuthorizeSetting.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Taro.getAppAuthorizeSetting() -sidebar_label: getAppAuthorizeSetting ---- - -获取微信APP授权设置 - -- 'authorized' 表示已经获得授权，无需再次请求授权； -- 'denied' 表示请求授权被拒绝，无法再次请求授权；（此情况需要引导用户[打开系统设置](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.openAppAuthorizeSetting.html)，在设置页中打开权限） -- 'non determined' 表示尚未请求授权，会在微信下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - -支持情况： - -> H5: 暂未支持设置权限 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getAppAuthorizeSetting.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| albumAuthorized | `keyof Authorized` | 允许微信使用相册的开关（仅 iOS 有效） | -| bluetoothAuthorized | `keyof Authorized` | 允许微信使用蓝牙的开关（仅 iOS 有效） | -| cameraAuthorized | `keyof Authorized` | 允许微信使用摄像头的开关 | -| locationAuthorized | `keyof Authorized` | 允许微信使用定位的开关 | -| locationReducedAccuracy | `boolean` | 定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 有效） | -| microphoneAuthorized | `keyof Authorized` | 允许微信使用麦克风的开关 | -| notificationAuthorized | `keyof Authorized` | 允许微信通知的开关 | -| notificationAlertAuthorized | `keyof Authorized` | 允许微信通知带有提醒的开关（仅 iOS 有效） | -| notificationBadgeAuthorized | `keyof Authorized` | 允许微信通知带有标记的开关（仅 iOS 有效） | -| notificationSoundAuthorized | `keyof Authorized` | 允许微信通知带有声音的开关（仅 iOS 有效） | -| phoneCalendarAuthorized | `keyof Authorized` | 允许微信读写日历的开关 | - -### Authorized - -授权合法值 - -| 参数 | 说明 | -| --- | --- | -| authorized | 表示已经获得授权，无需再次请求授权 | -| denied | 表示请求授权被拒绝，无法再次请求授权 （此情况需要引导用户打开[打开系统设置](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.openAppAuthorizeSetting.html)，在设置页中打开权限） | -| not determined | 表示尚未请求授权，会在微信下一次调用系统相应权限时请求 （仅 iOS 会出现。此种情况下引导用户[打开系统设置](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.openAppAuthorizeSetting.html)，不展示开关） | - -## 示例代码 - -```tsx -const appAuthorizeSetting = Taro.getAppAuthorizeSetting() - -console.log(appAuthorizeSetting.albumAuthorized) -console.log(appAuthorizeSetting.bluetoothAuthorized) -console.log(appAuthorizeSetting.cameraAuthorized) -console.log(appAuthorizeSetting.locationAuthorized) -console.log(appAuthorizeSetting.locationReducedAccuracy) -console.log(appAuthorizeSetting.microphoneAuthorized) -console.log(appAuthorizeSetting.notificationAlertAuthorized) -console.log(appAuthorizeSetting.notificationAuthorized) -console.log(appAuthorizeSetting.notificationBadgeAuthorized) -console.log(appAuthorizeSetting.notificationSoundAuthorized) -console.log(appAuthorizeSetting.phoneCalendarAuthorized) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getAppBaseInfo.md b/versioned_docs/version-4.x/apis/base/system/getAppBaseInfo.md deleted file mode 100644 index f408f4308af1..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getAppBaseInfo.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Taro.getAppBaseInfo() -sidebar_label: getAppBaseInfo ---- - -获取微信APP基础信息 - -支持情况： - -> H5: 不支持 SDKVersion、host、version - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getAppBaseInfo.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| SDKVersion | `string` | 否 | 客户端基础库版本 | -| enableDebug | `boolean` | 否 | 是否已打开调试。可通过右上角菜单或 [Taro.setEnableDebug](/docs/apis/base/debug/setEnableDebug) 打开调试。 | -| host | `Host` | 否 | 当前小程序运行的宿主环境 | -| language | `string` | 是 | 微信设置的语言 | -| version | `string` | 否 | 微信版本号 | -| theme | `keyof Theme` | 否 | 系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏） | - -### Theme - -系统主题合法值 - -| 参数 | 说明 | -| --- | --- | -| dark | 深色主题 | -| light | 浅色主题 | - -### Host - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 宿主 app 对应的 appId | - -## 示例代码 - -```tsx -const appBaseInfo = Taro.getAppBaseInfo() - -console.log(appBaseInfo.SDKVersion) -console.log(appBaseInfo.enableDebug) -console.log(appBaseInfo.host) -console.log(appBaseInfo.language) -console.log(appBaseInfo.version) -console.log(appBaseInfo.theme) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getDeviceInfo.md b/versioned_docs/version-4.x/apis/base/system/getDeviceInfo.md deleted file mode 100644 index 31d8839da129..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getDeviceInfo.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.getDeviceInfo() -sidebar_label: getDeviceInfo ---- - -获取设备基础信息 - -支持情况： - -> H5: 不支持 abi、benchmarkLevel - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getDeviceInfo.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| abi | `string` | 否 | 应用二进制接口类型（仅 Android 支持） | -| deviceAbi | `string` | 是 | 设备二进制接口类型（仅 Android 支持） | -| benchmarkLevel | `number` | 是 | 设备性能等级（仅Android小游戏）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50） | -| brand | `string` | 是 | 设备品牌 | -| model | `string` | 是 | 设备型号 | -| system | `string` | 是 | 操作系统及版本 | -| platform | `string` | 是 | 客户端平台 | -| CPUType | `string` | 是 | 设备 CPU 型号（仅 Android 支持） | - -## 示例代码 - -```tsx -const deviceInfo = Taro.getDeviceInfo() - -console.log(deviceInfo.abi) -console.log(deviceInfo.benchmarkLevel) -console.log(deviceInfo.brand) -console.log(deviceInfo.model) -console.log(deviceInfo.platform) -console.log(deviceInfo.system) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getRendererUserAgent.md b/versioned_docs/version-4.x/apis/base/system/getRendererUserAgent.md deleted file mode 100644 index 364335ca5994..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getRendererUserAgent.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.getRendererUserAgent(option) -sidebar_label: getRendererUserAgent ---- - -获取 Webview 小程序的 UserAgent -基础库 2.26.3 开始支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getRendererUserAgent.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: Result) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Result - -| 参数 | 类型 | -| --- | --- | -| userAgent | `string` | diff --git a/versioned_docs/version-4.x/apis/base/system/getSkylineInfo.md b/versioned_docs/version-4.x/apis/base/system/getSkylineInfo.md deleted file mode 100644 index 22dd1823e0af..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSkylineInfo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.getSkylineInfo(option) -sidebar_label: getSkylineInfo ---- - -获取当前运行环境对于 Skyline 渲染引擎 的支持情况 -基础库 2.26.2 开始支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSkylineInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: Result) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| isSupported | `boolean` | 是 | 当前运行环境是否支持 Skyline 渲染引擎 | -| version | `string` | 是 | 当前运行环境 Skyline 渲染引擎 的版本号，形如 0.9.7 | -| reason | `string` | 否 | 当前运行环境不支持 Skyline 渲染引擎 的原因，仅在 isSupported 为 false 时出现 | diff --git a/versioned_docs/version-4.x/apis/base/system/getSkylineInfoSync.md b/versioned_docs/version-4.x/apis/base/system/getSkylineInfoSync.md deleted file mode 100644 index 2b334942d48e..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSkylineInfoSync.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Taro.getSkylineInfoSync() -sidebar_label: getSkylineInfoSync ---- - -获取当前运行环境对于 Skyline 渲染引擎 的支持情况 -基础库 2.26.2 开始支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSkylineInfoSync.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| isSupported | `boolean` | 是 | 当前运行环境是否支持 Skyline 渲染引擎 | -| version | `string` | 是 | 当前运行环境 Skyline 渲染引擎 的版本号，形如 0.9.7 | -| reason | `string` | 否 | 当前运行环境不支持 Skyline 渲染引擎 的原因，仅在 isSupported 为 false 时出现 | diff --git a/versioned_docs/version-4.x/apis/base/system/getSystemInfo.md b/versioned_docs/version-4.x/apis/base/system/getSystemInfo.md deleted file mode 100644 index 9f32cef2a79e..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSystemInfo.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: Taro.getSystemInfo(res) -sidebar_label: getSystemInfo ---- - -获取系统信息，支持 `Promise` 化使用。 - -支持情况： - -> 微信小程序: 小程序可以在微信和企业微信中调用此接口，但是在企业微信中调用此接口时，会额外返回一个 environment 字段（微信中不返回），如此字段值为 wxwork，则表示当前小程序运行在企业微信环境中。 -> -> H5: 不支持 version、statusBarHeight、fontSizeSetting、SDKVersion - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/system-info/wx.getSystemInfo.html) - -## 类型 - -```tsx -(res?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: Result) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| brand | `string` | 是 | 设备品牌 | -| model | `string` | 是 | 设备型号 | -| pixelRatio | `number` | 是 | 设备像素比 | -| screenWidth | `number` | 是 | 屏幕宽度，单位px | -| screenHeight | `number` | 是 | 屏幕高度，单位px | -| windowWidth | `number` | 是 | 可使用窗口宽度，单位px | -| windowHeight | `number` | 是 | 可使用窗口高度，单位px | -| statusBarHeight | `number` | 否 | 状态栏的高度，单位px | -| language | `string` | 是 | 微信设置的语言 | -| version | `string` | 否 | 微信版本号 | -| system | `string` | 是 | 操作系统及版本 | -| platform | `string` | 是 | 客户端平台 | -| fontSizeSetting | `number` | 否 | 用户字体大小（单位px）。以微信客户端「我-设置-通用-字体大小」中的设置为准 | -| SDKVersion | `string` | 否 | 客户端基础库版本 | -| benchmarkLevel | `number` | 是 | 设备性能等级（仅Android小游戏）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50） | -| albumAuthorized | `boolean` | 否 | 允许微信使用相册的开关（仅 iOS 有效） | -| cameraAuthorized | `boolean` | 否 | 允许微信使用摄像头的开关 | -| locationAuthorized | `boolean` | 否 | 允许微信使用定位的开关 | -| microphoneAuthorized | `boolean` | 否 | 允许微信使用麦克风的开关 | -| notificationAuthorized | `boolean` | 否 | 允许微信通知的开关 | -| notificationAlertAuthorized | `boolean` | 否 | 允许微信通知带有提醒的开关（仅 iOS 有效） | -| notificationBadgeAuthorized | `boolean` | 否 | 允许微信通知带有标记的开关（仅 iOS 有效） | -| notificationSoundAuthorized | `boolean` | 否 | 允许微信通知带有声音的开关（仅 iOS 有效） | -| phoneCalendarAuthorized | `boolean` | 否 | 允许微信使用日历的开关 | -| bluetoothEnabled | `boolean` | 否 | 蓝牙的系统开关 | -| locationEnabled | `boolean` | 否 | 地理位置的系统开关 | -| wifiEnabled | `boolean` | 否 | Wi-Fi 的系统开关 | -| safeArea | `TaroGeneral.SafeAreaResult` | 否 | 在竖屏正方向下的安全区域 | -| locationReducedAccuracy | `boolean` | 否 | `true` 表示模糊定位，`false` 表示精确定位，仅 iOS 支持 | -| theme | `keyof Theme` | 否 | 系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏） | -| host | `Host` | 否 | 当前小程序运行的宿主环境 | -| enableDebug | `boolean` | 否 | 是否已打开调试。可通过右上角菜单或 [Taro.setEnableDebug](/docs/apis/base/debug/setEnableDebug) 打开调试。 | -| deviceOrientation | `keyof DeviceOrientation` | 否 | 设备方向 | -| environment | `string` | 否 | 小程序当前运行环境 | - -### Theme - -系统主题合法值 - -| 参数 | 说明 | -| --- | --- | -| dark | 深色主题 | -| light | 浅色主题 | - -### Host - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 宿主 app 对应的 appId | - -### DeviceOrientation - -设备方向合法值 - -| 参数 | 说明 | -| --- | --- | -| portrait | 竖屏 | -| landscape | 横屏 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.getSystemInfo({ - success: res => console.log(res) -}) -.then(res => console.log(res)) -``` - -### 示例 2 - -```tsx -Taro.getSystemInfo({ - success: function (res) { - console.log(res.model) - console.log(res.pixelRatio) - console.log(res.windowWidth) - console.log(res.windowHeight) - console.log(res.language) - console.log(res.version) - console.log(res.platform) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getSystemInfoAsync.md b/versioned_docs/version-4.x/apis/base/system/getSystemInfoAsync.md deleted file mode 100644 index b827c857616d..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSystemInfoAsync.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: Taro.getSystemInfoAsync(res) -sidebar_label: getSystemInfoAsync ---- - -异步获取系统信息。需要一定的微信客户端版本支持，在不支持的客户端上，会使用同步实现来返回。 - -支持情况： - -> 微信小程序: 小程序可以在微信和企业微信中调用此接口，但是在企业微信中调用此接口时，会额外返回一个 environment 字段（微信中不返回），如此字段值为 wxwork，则表示当前小程序运行在企业微信环境中。 -> -> H5: 不支持 version、statusBarHeight、fontSizeSetting、SDKVersion - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSystemInfoAsync.html) - -## 类型 - -```tsx -(res?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: Result) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| brand | `string` | 是 | 设备品牌 | -| model | `string` | 是 | 设备型号 | -| pixelRatio | `number` | 是 | 设备像素比 | -| screenWidth | `number` | 是 | 屏幕宽度，单位px | -| screenHeight | `number` | 是 | 屏幕高度，单位px | -| windowWidth | `number` | 是 | 可使用窗口宽度，单位px | -| windowHeight | `number` | 是 | 可使用窗口高度，单位px | -| statusBarHeight | `number` | 否 | 状态栏的高度，单位px | -| language | `string` | 是 | 微信设置的语言 | -| version | `string` | 否 | 微信版本号 | -| system | `string` | 是 | 操作系统及版本 | -| platform | `string` | 是 | 客户端平台 | -| fontSizeSetting | `number` | 否 | 用户字体大小（单位px）。以微信客户端「我-设置-通用-字体大小」中的设置为准 | -| SDKVersion | `string` | 否 | 客户端基础库版本 | -| benchmarkLevel | `number` | 是 | 设备性能等级（仅Android小游戏）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50） | -| albumAuthorized | `boolean` | 否 | 允许微信使用相册的开关（仅 iOS 有效） | -| cameraAuthorized | `boolean` | 否 | 允许微信使用摄像头的开关 | -| locationAuthorized | `boolean` | 否 | 允许微信使用定位的开关 | -| microphoneAuthorized | `boolean` | 否 | 允许微信使用麦克风的开关 | -| notificationAuthorized | `boolean` | 否 | 允许微信通知的开关 | -| notificationAlertAuthorized | `boolean` | 否 | 允许微信通知带有提醒的开关（仅 iOS 有效） | -| notificationBadgeAuthorized | `boolean` | 否 | 允许微信通知带有标记的开关（仅 iOS 有效） | -| notificationSoundAuthorized | `boolean` | 否 | 允许微信通知带有声音的开关（仅 iOS 有效） | -| phoneCalendarAuthorized | `boolean` | 否 | 允许微信使用日历的开关 | -| bluetoothEnabled | `boolean` | 否 | 蓝牙的系统开关 | -| locationEnabled | `boolean` | 否 | 地理位置的系统开关 | -| wifiEnabled | `boolean` | 否 | Wi-Fi 的系统开关 | -| safeArea | `TaroGeneral.SafeAreaResult` | 否 | 在竖屏正方向下的安全区域 | -| locationReducedAccuracy | `boolean` | 否 | `true` 表示模糊定位，`false` 表示精确定位，仅 iOS 支持 | -| theme | `keyof Theme` | 否 | 系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏） | -| host | `Host` | 否 | 当前小程序运行的宿主环境 | -| enableDebug | `boolean` | 否 | 是否已打开调试。可通过右上角菜单或 [Taro.setEnableDebug](/docs/apis/base/debug/setEnableDebug) 打开调试。 | -| deviceOrientation | `keyof DeviceOrientation` | 否 | 设备方向 | -| environment | `string` | 否 | 小程序当前运行环境 | - -### Theme - -系统主题合法值 - -| 参数 | 说明 | -| --- | --- | -| dark | 深色主题 | -| light | 浅色主题 | - -### Host - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 宿主 app 对应的 appId | - -### DeviceOrientation - -设备方向合法值 - -| 参数 | 说明 | -| --- | --- | -| portrait | 竖屏 | -| landscape | 横屏 | - -## 示例代码 - -```tsx -Taro.getSystemInfoAsync({ - success (res) { - console.log(res.model) - console.log(res.pixelRatio) - console.log(res.windowWidth) - console.log(res.windowHeight) - console.log(res.language) - console.log(res.version) - console.log(res.platform) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getSystemInfoSync.md b/versioned_docs/version-4.x/apis/base/system/getSystemInfoSync.md deleted file mode 100644 index 06250a223a5d..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSystemInfoSync.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Taro.getSystemInfoSync() -sidebar_label: getSystemInfoSync ---- - -[Taro.getSystemInfo](./getSystemInfo) 的同步版本 - -支持情况： - -> 微信小程序: 小程序可以在微信和企业微信中调用此接口，但是在企业微信中调用此接口时，会额外返回一个 environment 字段（微信中不返回），如此字段值为 wxwork，则表示当前小程序运行在企业微信环境中。 -> -> H5: 不支持 version、statusBarHeight、fontSizeSetting、SDKVersion - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/system-info/wx.getSystemInfoSync.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| brand | `string` | 是 | 设备品牌 | -| model | `string` | 是 | 设备型号 | -| pixelRatio | `number` | 是 | 设备像素比 | -| screenWidth | `number` | 是 | 屏幕宽度，单位px | -| screenHeight | `number` | 是 | 屏幕高度，单位px | -| windowWidth | `number` | 是 | 可使用窗口宽度，单位px | -| windowHeight | `number` | 是 | 可使用窗口高度，单位px | -| statusBarHeight | `number` | 否 | 状态栏的高度，单位px | -| language | `string` | 是 | 微信设置的语言 | -| version | `string` | 否 | 微信版本号 | -| system | `string` | 是 | 操作系统及版本 | -| platform | `string` | 是 | 客户端平台 | -| fontSizeSetting | `number` | 否 | 用户字体大小（单位px）。以微信客户端「我-设置-通用-字体大小」中的设置为准 | -| SDKVersion | `string` | 否 | 客户端基础库版本 | -| benchmarkLevel | `number` | 是 | 设备性能等级（仅Android小游戏）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50） | -| albumAuthorized | `boolean` | 否 | 允许微信使用相册的开关（仅 iOS 有效） | -| cameraAuthorized | `boolean` | 否 | 允许微信使用摄像头的开关 | -| locationAuthorized | `boolean` | 否 | 允许微信使用定位的开关 | -| microphoneAuthorized | `boolean` | 否 | 允许微信使用麦克风的开关 | -| notificationAuthorized | `boolean` | 否 | 允许微信通知的开关 | -| notificationAlertAuthorized | `boolean` | 否 | 允许微信通知带有提醒的开关（仅 iOS 有效） | -| notificationBadgeAuthorized | `boolean` | 否 | 允许微信通知带有标记的开关（仅 iOS 有效） | -| notificationSoundAuthorized | `boolean` | 否 | 允许微信通知带有声音的开关（仅 iOS 有效） | -| phoneCalendarAuthorized | `boolean` | 否 | 允许微信使用日历的开关 | -| bluetoothEnabled | `boolean` | 否 | 蓝牙的系统开关 | -| locationEnabled | `boolean` | 否 | 地理位置的系统开关 | -| wifiEnabled | `boolean` | 否 | Wi-Fi 的系统开关 | -| safeArea | `TaroGeneral.SafeAreaResult` | 否 | 在竖屏正方向下的安全区域 | -| locationReducedAccuracy | `boolean` | 否 | `true` 表示模糊定位，`false` 表示精确定位，仅 iOS 支持 | -| theme | `keyof Theme` | 否 | 系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏） | -| host | `Host` | 否 | 当前小程序运行的宿主环境 | -| enableDebug | `boolean` | 否 | 是否已打开调试。可通过右上角菜单或 [Taro.setEnableDebug](/docs/apis/base/debug/setEnableDebug) 打开调试。 | -| deviceOrientation | `keyof DeviceOrientation` | 否 | 设备方向 | -| environment | `string` | 否 | 小程序当前运行环境 | - -### Theme - -系统主题合法值 - -| 参数 | 说明 | -| --- | --- | -| dark | 深色主题 | -| light | 浅色主题 | - -### Host - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 宿主 app 对应的 appId | - -### DeviceOrientation - -设备方向合法值 - -| 参数 | 说明 | -| --- | --- | -| portrait | 竖屏 | -| landscape | 横屏 | - -## 示例代码 - -```tsx -try { - const res = Taro.getSystemInfoSync() - console.log(res.model) - console.log(res.pixelRatio) - console.log(res.windowWidth) - console.log(res.windowHeight) - console.log(res.language) - console.log(res.version) - console.log(res.platform) -} catch (e) { - // Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getSystemSetting.md b/versioned_docs/version-4.x/apis/base/system/getSystemSetting.md deleted file mode 100644 index 580f96e60a7b..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getSystemSetting.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.getSystemSetting() -sidebar_label: getSystemSetting ---- - -获取设备设置 - -支持情况： - -> H5: 不支持 bluetoothEnabled、locationEnabled、wifiEnabled - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSystemSetting.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| bluetoothEnabled | `boolean` | 否 | 蓝牙的系统开关 | -| locationEnabled | `boolean` | 否 | 地理位置的系统开关 | -| wifiEnabled | `boolean` | 否 | Wi-Fi 的系统开关 | -| deviceOrientation | `keyof DeviceOrientation` | 否 | 设备方向 | - -### DeviceOrientation - -设备方向合法值 - -| 参数 | 说明 | -| --- | --- | -| portrait | 竖屏 | -| landscape | 横屏 | - -## 示例代码 - -```tsx -const systemSetting = Taro.getSystemSetting() - -console.log(systemSetting.bluetoothEnabled) -console.log(systemSetting.deviceOrientation) -console.log(systemSetting.locationEnabled) -console.log(systemSetting.wifiEnabled) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/getWindowInfo.md b/versioned_docs/version-4.x/apis/base/system/getWindowInfo.md deleted file mode 100644 index 177bcbd81674..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/getWindowInfo.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.getWindowInfo() -sidebar_label: getWindowInfo ---- - -获取窗口信息 - -支持情况： - -> H5: 不支持 statusBarHeight、safeArea - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getWindowInfo.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| pixelRatio | `number` | 是 | 设备像素比 | -| screenWidth | `number` | 是 | 屏幕宽度，单位px | -| screenHeight | `number` | 是 | 屏幕高度，单位px | -| windowWidth | `number` | 是 | 可使用窗口宽度，单位px | -| windowHeight | `number` | 是 | 可使用窗口高度，单位px | -| statusBarHeight | `number` | 否 | 状态栏的高度，单位px | -| safeArea | `TaroGeneral.SafeAreaResult` | 否 | 在竖屏正方向下的安全区域 | - -## 示例代码 - -```tsx -const windowInfo = Taro.getWindowInfo() - -console.log(windowInfo.pixelRatio) -console.log(windowInfo.screenWidth) -console.log(windowInfo.screenHeight) -console.log(windowInfo.windowWidth) -console.log(windowInfo.windowHeight) -console.log(windowInfo.statusBarHeight) -console.log(windowInfo.safeArea) -console.log(windowInfo.screenTop) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/openAppAuthorizeSetting.md b/versioned_docs/version-4.x/apis/base/system/openAppAuthorizeSetting.md deleted file mode 100644 index 3b265f998279..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/openAppAuthorizeSetting.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.openAppAuthorizeSetting(option) -sidebar_label: openAppAuthorizeSetting ---- - -跳转系统微信授权管理页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.openAppAuthorizeSetting.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.openAppAuthorizeSetting({ - success (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/system/openSystemBluetoothSetting.md b/versioned_docs/version-4.x/apis/base/system/openSystemBluetoothSetting.md deleted file mode 100644 index 2e85d1233192..000000000000 --- a/versioned_docs/version-4.x/apis/base/system/openSystemBluetoothSetting.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.openSystemBluetoothSetting(option) -sidebar_label: openSystemBluetoothSetting ---- - -跳转系统蓝牙设置页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.openSystemBluetoothSetting.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.openSystemBluetoothSetting({ - success (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/update/UpdateManager.md b/versioned_docs/version-4.x/apis/base/update/UpdateManager.md deleted file mode 100644 index db266c167876..000000000000 --- a/versioned_docs/version-4.x/apis/base/update/UpdateManager.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: UpdateManager -sidebar_label: UpdateManager ---- - -UpdateManager 对象，用来管理更新，可通过 Taro.getUpdateManager 接口获取实例。 - -**Tips** -- 微信开发者工具上可以通过「编译模式」下的「下次编译模拟更新」开关来调试 -- 小程序开发版/体验版没有「版本」概念，所以无法在开发版/体验版上测试更版本更新情况 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/UpdateManager.html) - -## 方法 - -### applyUpdate - -强制小程序重启并使用新版本。在小程序新版本下载完成后（即收到 `onUpdateReady` 回调）调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/UpdateManager.applyUpdate.html) - -```tsx -() => void -``` - -### onCheckForUpdate - -监听向微信后台请求检查更新结果事件。微信在小程序冷启动时自动检查更新，不需由开发者主动触发。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/UpdateManager.onCheckForUpdate.html) - -```tsx -(callback: OnCheckForUpdateCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnCheckForUpdateCallback` | 向微信后台请求检查更新结果事件的回调函数 | - -### onUpdateReady - -监听小程序有版本更新事件。客户端主动触发下载（无需开发者触发），下载成功后回调 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/UpdateManager.onUpdateReady.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 小程序有版本更新事件的回调函数 | - -### onUpdateFailed - -监听小程序更新失败事件。小程序有新版本，客户端主动触发下载（无需开发者触发），下载失败（可能是网络原因等）后回调 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/UpdateManager.onUpdateFailed.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 小程序更新失败事件的回调函数 | - -## 参数 - -### OnCheckForUpdateCallback - -向微信后台请求检查更新结果事件的回调函数 - -```tsx -(result: OnCheckForUpdateResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnCheckForUpdateResult` | - -### OnCheckForUpdateResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| hasUpdate | `boolean` | 是否有新版本 | - -## 示例代码 - -```tsx -const updateManager = Taro.getUpdateManager() - -updateManager.onCheckForUpdate(function (res) { - // 请求完新版本信息的回调 - console.log(res.hasUpdate) -}) - -updateManager.onUpdateReady(function () { - wx.showModal({ - title: '更新提示', - content: '新版本已经准备好，是否重启应用？', - success: function (res) { - if (res.confirm) { - // 新的版本已经下载好，调用 applyUpdate 应用新版本并重启 - updateManager.applyUpdate() - } - } - }) -}) - -updateManager.onUpdateFailed(function () { - // 新版本下载失败 -}) -``` - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| UpdateManager | ✔️ | ✔️ | | | | -| UpdateManager.applyUpdate | ✔️ | ✔️ | | | | -| UpdateManager.onCheckForUpdate | ✔️ | ✔️ | | | | -| UpdateManager.onUpdateReady | ✔️ | ✔️ | | | | -| UpdateManager.onUpdateFailed | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/base/update/getUpdateManager.md b/versioned_docs/version-4.x/apis/base/update/getUpdateManager.md deleted file mode 100644 index 9f96167c591a..000000000000 --- a/versioned_docs/version-4.x/apis/base/update/getUpdateManager.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.getUpdateManager() -sidebar_label: getUpdateManager ---- - -获取**全局唯一**的版本更新管理器，用于管理小程序更新。 -关于小程序的更新机制，可以查看[运行机制](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/operating-mechanism.html)文档。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/wx.getUpdateManager.html) - -## 类型 - -```tsx -() => UpdateManager -``` - -## 示例代码 - -```tsx -const updateManager = Taro.getUpdateManager() - updateManager.onCheckForUpdate(function (res) { - // 请求完新版本信息的回调 - console.log(res.hasUpdate) -}) -updateManager.onUpdateReady(function () { - Taro.showModal({ - title: '更新提示', - content: '新版本已经准备好，是否重启应用？', - success: function (res) { - if (res.confirm) { - // 新的版本已经下载好，调用 applyUpdate 应用新版本并重启 - updateManager.applyUpdate() - } - } - }) -}) -updateManager.onUpdateFailed(function () { - // 新的版本下载失败 -}) -``` diff --git a/versioned_docs/version-4.x/apis/base/update/updateWeChatApp.md b/versioned_docs/version-4.x/apis/base/update/updateWeChatApp.md deleted file mode 100644 index 4cab6c1dcf91..000000000000 --- a/versioned_docs/version-4.x/apis/base/update/updateWeChatApp.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.updateWeChatApp(option) -sidebar_label: updateWeChatApp ---- - -更新客户端版本。当判断用户小程序所在客户端版本过低时，可使用该接口跳转到更新微信页面。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/update/wx.updateWeChatApp.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppHide.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppHide.md deleted file mode 100644 index 6e9f09c0adae..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppHide.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offAppHide(callback) -sidebar_label: offAppHide ---- - -取消监听小程序切后台事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppHide.html) - -## 类型 - -```tsx -(callback: (res: CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: CallbackResult) => void` | 小程序切后台事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppShow.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppShow.md deleted file mode 100644 index 949f7e2fcb05..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAppShow.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offAppShow(callback) -sidebar_label: offAppShow ---- - -取消监听小程序切前台事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAppShow.html) - -## 类型 - -```tsx -(callback: (res: CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: CallbackResult) => void` | 小程序切前台事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionBegin.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionBegin.md deleted file mode 100644 index f59ed02f93de..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionBegin.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offAudioInterruptionBegin(callback) -sidebar_label: offAudioInterruptionBegin ---- - -取消监听音频因为受到系统占用而被中断开始事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAudioInterruptionBegin.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音频因为受到系统占用而被中断开始事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionEnd.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionEnd.md deleted file mode 100644 index 0a5a30033633..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offAudioInterruptionEnd.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offAudioInterruptionEnd(callback) -sidebar_label: offAudioInterruptionEnd ---- - -取消监听音频中断结束事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offAudioInterruptionEnd.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音频中断结束事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offError.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offError.md deleted file mode 100644 index 0b017cf58487..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offError.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offError(callback) -sidebar_label: offError ---- - -取消监听音频播放错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/InnerAudioContext.offError.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 音频播放错误事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offPageNotFound.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offPageNotFound.md deleted file mode 100644 index 88eebb301782..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offPageNotFound.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offPageNotFound(callback) -sidebar_label: offPageNotFound ---- - -取消监听小程序要打开的页面不存在事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offPageNotFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 小程序要打开的页面不存在事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offThemeChange.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offThemeChange.md deleted file mode 100644 index efce5fbb875a..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offThemeChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offThemeChange(callback) -sidebar_label: offThemeChange ---- - -取消监听系统主题改变事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offThemeChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/offUnhandledRejection.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/offUnhandledRejection.md deleted file mode 100644 index 50795908e242..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/offUnhandledRejection.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offUnhandledRejection(callback) -sidebar_label: offUnhandledRejection ---- - -取消监听未处理的 Promise 拒绝事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.offUnhandledRejection.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `T` | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppHide.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppHide.md deleted file mode 100644 index d260c2979c1c..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppHide.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.onAppHide(callback) -sidebar_label: onAppHide ---- - -监听小程序切后台事件。该事件与 [`App.onHide`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onhide) 的回调时机一致。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppHide.html) - -## 类型 - -```tsx -(callback: (res: CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: CallbackResult) => void` | 小程序切后台事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppShow.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppShow.md deleted file mode 100644 index 2a27b1ed1949..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAppShow.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Taro.onAppShow(callback) -sidebar_label: onAppShow ---- - -监听小程序切前台事件。该事件与 [`App.onShow`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onshowobject-object) 的回调参数一致。 - -**返回有效 referrerInfo 的场景** - -| 场景值 | 场景 | appId含义 | -| ------ | ------------------------------- | ---------- | -| 1020 | 公众号 profile 页相关小程序列表 | 来源公众号 | -| 1035 | 公众号自定义菜单 | 来源公众号 | -| 1036 | App 分享消息卡片 | 来源App | -| 1037 | 小程序打开小程序 | 来源小程序 | -| 1038 | 从另一个小程序返回 | 来源小程序 | -| 1043 | 公众号模板消息 | 来源公众号 | - -**注意** - -部分版本在无`referrerInfo`的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAppShow.html) - -## 类型 - -```tsx -(callback: (res: CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: CallbackResult) => void` | 小程序切前台事件的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 小程序切前台的路径 | -| query | `TaroGeneral.IAnyObject` | 是 | 小程序切前台的 query 参数 | -| shareTicket | `string` | 是 | shareTicket，详见[获取更多转发信息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | -| scene | `number` | 是 | 小程序切前台的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) | -| referrerInfo | `ResultReferrerInfo` | 是 | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) | -| forwardMaterials | `ForwardMaterial[]` | 否 | 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数 | -| chatType | `keyof ChatType` | 否 | 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型 | -| apiCategory | `keyof ApiCategory` | 否 | API 类别 | - -### ResultReferrerInfo - -来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| appId | `string` | 否 | 来源小程序、公众号或 App 的 appId | -| extraData | `TaroGeneral.IAnyObject` | 否 | 来源小程序传过来的数据，scene=1037或1038时支持 | - -### ForwardMaterial - -ChatType 类型合法值 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `string` | 文件的mimetype类型 | -| name | `string` | 文件名 | -| path | `string` | 文件路径（如果是webview则是url） | -| size | `number` | 文件大小 | - -### ChatType - -ChatType 类型合法值 - -| 参数 | 说明 | -| --- | --- | -| 1 | 微信联系人单聊 | -| 2 | 企业微信联系人单聊 | -| 3 | 普通微信群聊 | -| 4 | 企业微信互通群聊 | - -### ApiCategory - -API 类别合法值 - -| 参数 | 说明 | -| --- | --- | -| default | 默认类别 | -| nativeFunctionalized | 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序 | -| browseOnly | 仅浏览，朋友圈快照页等场景打开的小程序 | -| embedded | 内嵌，通过打开半屏小程序能力打开的小程序 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionBegin.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionBegin.md deleted file mode 100644 index ca72421560f3..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionBegin.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.onAudioInterruptionBegin(callback) -sidebar_label: onAudioInterruptionBegin ---- - -监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件：闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后，小程序内所有音频会暂停。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAudioInterruptionBegin.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音频因为受到系统占用而被中断开始事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionEnd.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionEnd.md deleted file mode 100644 index dfb22c7325d3..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onAudioInterruptionEnd.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.onAudioInterruptionEnd(callback) -sidebar_label: onAudioInterruptionEnd ---- - -监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后，小程序内所有音频会暂停，收到此事件之后才可再次播放成功 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onAudioInterruptionEnd.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音频中断结束事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onError.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onError.md deleted file mode 100644 index fa287c0a4355..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onError.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.onError(callback) -sidebar_label: onError ---- - -监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 [`App.onError`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onerrorstring-error) 的回调时机与参数一致。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onError.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Callback - -小程序错误事件的回调函数 - -```tsx -(error: string | ErrorEvent | Error) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| error | string or ErrorEvent or Error | 错误信息，包含堆栈 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onPageNotFound.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onPageNotFound.md deleted file mode 100644 index d457a1a04cef..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onPageNotFound.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.onPageNotFound(callback) -sidebar_label: onPageNotFound ---- - -监听小程序要打开的页面不存在事件。该事件与 [`App.onPageNotFound`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onpagenotfoundobject-object) 的回调时机一致。 - -**注意** -- 开发者可以在回调中进行页面重定向，但必须在回调中**同步**处理，异步处理（例如 `setTimeout` 异步执行）无效。 -- 若开发者没有调用 [Taro.onPageNotFound](/docs/apis/base/weapp/app-event/onPageNotFound) 绑定监听，也没有声明 `App.onPageNotFound`，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。 -- 如果回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再第二次回调。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onPageNotFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isEntryPage | `boolean` | 是否本次启动的首个页面（例如从分享等入口进来，首个页面是开发者配置的分享页面） | -| path | `string` | 不存在页面的路径 | -| query | `TaroGeneral.IAnyObject` | 打开不存在页面的 query 参数 | - -### Callback - -小程序要打开的页面不存在事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onThemeChange.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onThemeChange.md deleted file mode 100644 index 874c470d4dec..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onThemeChange.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.onThemeChange(callback) -sidebar_label: onThemeChange ---- - -监听系统主题改变事件。该事件与 [`App.onThemeChange`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onThemeChange-Object-object) 的回调时机一致。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onThemeChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Callback - -系统主题改变事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| theme | `keyof ITheme` | 系统当前的主题，取值为`light`或`dark` | - -### ITheme - -| 参数 | 说明 | -| --- | --- | -| light | 浅色主题 | -| dark | 深色主题 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/app-event/onUnhandledRejection.md b/versioned_docs/version-4.x/apis/base/weapp/app-event/onUnhandledRejection.md deleted file mode 100644 index 91b6a612e267..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/app-event/onUnhandledRejection.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onUnhandledRejection(callback) -sidebar_label: onUnhandledRejection ---- - -监听未处理的 Promise 拒绝事件。该事件与 [`App.onUnhandledRejection`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onUnhandledRejection-Object-object) 的回调时机与参数一致。 - -**注意** -- 所有的 unhandledRejection 都可以被这一监听捕获，但只有 Error 类型的才会在小程序后台触发报警。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `T` | - -### Callback - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| reason | string or Error | 拒绝原因，一般是一个 Error 对象 | -| promise | `Promise` | 被拒绝的 Promise 对象 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getEnterOptionsSync.md b/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getEnterOptionsSync.md deleted file mode 100644 index dbbfa5b36905..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getEnterOptionsSync.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.getEnterOptionsSync() -sidebar_label: getEnterOptionsSync ---- - -获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 [`App.onLaunch`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onLaunch-Object-object) 的回调参数一致；如果当前是热启动，则返回值与 [`App.onShow`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object) 一致。 - -**注意** -部分版本在无 `referrerInfo` 的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getEnterOptionsSync.html) - -## 类型 - -```tsx -() => EnterOptions -``` - -## 参数 - -### EnterOptions - -启动参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 启动小程序的路径 | -| scene | `number` | 是 | 启动小程序的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) | -| query | `TaroGeneral.IAnyObject` | 是 | 启动小程序的 query 参数 | -| shareTicket | `string` | 是 | shareTicket，详见[获取更多转发信息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | -| referrerInfo | `ReferrerInfo` | 是 | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) | -| forwardMaterials | `ForwardMaterial[]` | 否 | 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数 | -| chatType | `keyof ChatType` | 否 | 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型 | -| apiCategory | `keyof ApiCategory` | 否 | API 类别 | - -#### ReferrerInfo - -来源信息 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| appId | `string` | 否 | 来源小程序、公众号或 App 的 appId | -| extraData | `TaroGeneral.IAnyObject` | 否 | 来源小程序传过来的数据，scene=1037或1038时支持 | - -#### ForwardMaterial - -ChatType 类型合法值 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `string` | 文件的mimetype类型 | -| name | `string` | 文件名 | -| path | `string` | 文件路径（如果是webview则是url） | -| size | `number` | 文件大小 | - -#### ChatType - -ChatType 类型合法值 - -| 参数 | 说明 | -| --- | --- | -| 1 | 微信联系人单聊 | -| 2 | 企业微信联系人单聊 | -| 3 | 普通微信群聊 | -| 4 | 企业微信互通群聊 | - -#### ApiCategory - -API 类别合法值 - -| 参数 | 说明 | -| --- | --- | -| default | 默认类别 | -| nativeFunctionalized | 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序 | -| browseOnly | 仅浏览，朋友圈快照页等场景打开的小程序 | -| embedded | 内嵌，通过打开半屏小程序能力打开的小程序 | diff --git a/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getLaunchOptionsSync.md b/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getLaunchOptionsSync.md deleted file mode 100644 index e08c196a19c4..000000000000 --- a/versioned_docs/version-4.x/apis/base/weapp/life-cycle/getLaunchOptionsSync.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.getLaunchOptionsSync() -sidebar_label: getLaunchOptionsSync ---- - -获取小程序启动时的参数。与 [`App.onLaunch`](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onlaunchobject-object) 的回调参数一致。 - -**注意** -部分版本在无`referrerInfo`的时候会返回 `undefined`，建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html) - -## 类型 - -```tsx -() => LaunchOptions -``` - -## 参数 - -### LaunchOptions - -启动参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 启动小程序的路径 | -| query | `TaroGeneral.IAnyObject` | 是 | 启动小程序的 query 参数 | -| scene | `number` | 是 | 启动小程序的[场景值](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/scene.html) | -| shareTicket | `string` | 是 | shareTicket，详见[获取更多转发信息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | -| referrerInfo | `ReferrerInfo` | 是 | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) | -| forwardMaterials | `ForwardMaterial[]` | 否 | 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数 | -| chatType | `keyof ChatType` | 否 | 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型 | -| apiCategory | `keyof ApiCategory` | 否 | API 类别 | - -#### ReferrerInfo - -来源信息 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| appId | `string` | 否 | 来源小程序、公众号或 App 的 appId | -| extraData | `TaroGeneral.IAnyObject` | 否 | 来源小程序传过来的数据，scene=1037或1038时支持 | - -#### ForwardMaterial - -ChatType 类型合法值 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `string` | 文件的mimetype类型 | -| name | `string` | 文件名 | -| path | `string` | 文件路径（如果是webview则是url） | -| size | `number` | 文件大小 | - -#### ChatType - -ChatType 类型合法值 - -| 参数 | 说明 | -| --- | --- | -| 1 | 微信联系人单聊 | -| 2 | 企业微信联系人单聊 | -| 3 | 普通微信群聊 | -| 4 | 企业微信互通群聊 | - -#### ApiCategory - -API 类别合法值 - -| 参数 | 说明 | -| --- | --- | -| default | 默认类别 | -| nativeFunctionalized | 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序 | -| browseOnly | 仅浏览，朋友圈快照页等场景打开的小程序 | -| embedded | 内嵌，通过打开半屏小程序能力打开的小程序 | diff --git a/versioned_docs/version-4.x/apis/canvas/Canvas.md b/versioned_docs/version-4.x/apis/canvas/Canvas.md deleted file mode 100644 index e3ca90861782..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/Canvas.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Canvas -sidebar_label: Canvas ---- - -Canvas 实例，可通过 SelectorQuery 获取。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| height | `number` | 画布高度 | -| width | `number` | 画布宽度 | - -### cancelAnimationFrame - -取消由 requestAnimationFrame 添加到计划中的动画帧请求。支持在 2D Canvas 和 WebGL Canvas 下使用, 但不支持混用 2D 和 WebGL 的方法。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.cancelAnimationFrame.html) - -```tsx -(requestID: number) => void -``` - -| 参数 | 类型 | -| --- | --- | -| requestID | `number` | - -### createImageData - -创建一个 ImageData 对象。仅支持在 2D Canvas 中使用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.createImageData.html) - -```tsx -() => ImageData -``` - -### createImage - -创建一个图片对象。 支持在 2D Canvas 和 WebGL Canvas 下使用, 但不支持混用 2D 和 WebGL 的方法。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.createImage.html) - -```tsx -() => Image -``` - -### createPath2D - -创建 Path2D 对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Path2D.html) - -```tsx -(path: Path2D) => Path2D -``` - -| 参数 | 类型 | -| --- | --- | -| path | `Path2D` | - -### getContext - -支持获取 2D 和 WebGL 绘图上下文 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.getContext.html) - -```tsx -(contextType: string) => RenderingContext -``` - -| 参数 | 类型 | -| --- | --- | -| contextType | `string` | - -### requestAnimationFrame - -在下次进行重绘时执行。 支持在 2D Canvas 和 WebGL Canvas 下使用, 但不支持混用 2D 和 WebGL 的方法。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.requestAnimationFrame.html) - -```tsx -(callback: (...args: any[]) => any) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(...args: any[]) => any` | 执行的 callback | - -### toDataURL - -返回一个包含图片展示的 data URI 。可以使用 type 参数其类型，默认为 PNG 格式。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Canvas.toDataURL.html) - -```tsx -(type: string, encoderOptions: number) => string -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `string` | 图片格式，默认为 image/png | -| encoderOptions | `number` | 在指定图片格式为 image/jpeg 或 image/webp的情况下，可以从 0 到 1 的区间内选择图片的质量。如果超出取值范围，将会使用默认值 0.92。其他参数会被忽略。 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Canvas.cancelAnimationFrame | ✔️ | | | | -| Canvas.createImageData | ✔️ | | | | -| Canvas.createImage | ✔️ | | | | -| Canvas.createPath2D | ✔️ | | | | -| Canvas.getContext | ✔️ | | | | -| Canvas.requestAnimationFrame | ✔️ | | | | -| Canvas.toDataURL | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/canvas/CanvasContext.md b/versioned_docs/version-4.x/apis/canvas/CanvasContext.md deleted file mode 100644 index 184063ef9479..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/CanvasContext.md +++ /dev/null @@ -1,1636 +0,0 @@ ---- -title: CanvasContext -sidebar_label: CanvasContext ---- - -canvas 组件的绘图上下文 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fillStyle | `string` | 填充颜色。用法同 [CanvasContext.setFillStyle()]。 | -| strokeStyle | `string` | 边框颜色。用法同 [CanvasContext.setFillStyle()]。 | -| shadowOffsetX | `number` | 阴影相对于形状在水平方向的偏移 | -| shadowOffsetY | `number` | 阴影相对于形状在竖直方向的偏移 | -| shadowBlur | `number` | 阴影的模糊级别 | -| shadowColor | `string` | 阴影的颜色 | -| lineWidth | `number` | 线条的宽度。用法同 [CanvasContext.setLineWidth()]。 | -| lineCap | `keyof LineCap` | 线条的端点样式。用法同 [CanvasContext.setLineCap()]。 | -| lineJoin | `keyof LineJoin` | 线条的交点样式。用法同 [CanvasContext.setLineJoin()]。 | -| miterLimit | `number` | 最大斜接长度。用法同 [CanvasContext.setMiterLimit()]。 | -| lineDashOffset | `number` | 虚线偏移量，初始值为0 | -| font | `string` | 当前字体样式的属性。符合 [CSS font 语法](https://developer.mozilla.org/zh-CN/docs/Web/CSS/font) 的 DOMString 字符串，至少需要提供字体大小和字体族名。默认值为 10px sans-serif。 | -| globalAlpha | `number` | 全局画笔透明度。范围 0-1，0 表示完全透明，1 表示完全不透明。 | -| globalCompositeOperation | `string` | 在绘制新形状时应用的合成操作的类型。目前安卓版本只适用于 `fill` 填充块的合成，用于 `stroke` 线段的合成效果都是 `source-over`。

目前支持的操作有
- 安卓：xor, source-over, source-atop, destination-out, lighter, overlay, darken, lighten, hard-light
- iOS：xor, source-over, source-atop, destination-over, destination-out, lighter, multiply, overlay, darken, lighten, color-dodge, color-burn, hard-light, soft-light, difference, exclusion, saturation, luminosity | - -### arc - -创建一条弧线。 - -- 创建一个圆可以指定起始弧度为 0，终止弧度为 2 * Math.PI。 -- 用 `stroke` 或者 `fill` 方法来在 `canvas` 中画弧线。 - -针对 arc(100, 75, 50, 0, 1.5 * Math.PI)的三个关键坐标如下： - -- 绿色: 圆心 (100, 75) -- 红色: 起始弧度 (0) -- 蓝色: 终止弧度 (1.5 * Math.PI) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.arc.html) - -```tsx -(x: number, y: number, r: number, sAngle: number, eAngle: number, counterclockwise?: boolean) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 圆心的 x 坐标 | -| y | `number` | 圆心的 y 坐标 | -| r | `number` | 圆的半径 | -| sAngle | `number` | 起始弧度，单位弧度（在3点钟方向） | -| eAngle | `number` | 终止弧度 | -| counterclockwise | `boolean` | 弧度的方向是否是逆时针 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Draw coordinates -ctx.arc(100, 75, 50, 0, 2 * Math.PI) -ctx.setFillStyle('#EEEEEE') -ctx.fill() -ctx.beginPath() -ctx.moveTo(40, 75) -ctx.lineTo(160, 75) -ctx.moveTo(100, 15) -ctx.lineTo(100, 135) -ctx.setStrokeStyle('#AAAAAA') -ctx.stroke() -ctx.setFontSize(12) -ctx.setFillStyle('black') -ctx.fillText('0', 165, 78) -ctx.fillText('0.5*PI', 83, 145) -ctx.fillText('1*PI', 15, 78) -ctx.fillText('1.5*PI', 83, 10) -// Draw points -ctx.beginPath() -ctx.arc(100, 75, 2, 0, 2 * Math.PI) -ctx.setFillStyle('lightgreen') -ctx.fill() -ctx.beginPath() -ctx.arc(100, 25, 2, 0, 2 * Math.PI) -ctx.setFillStyle('blue') -ctx.fill() -ctx.beginPath() -ctx.arc(150, 75, 2, 0, 2 * Math.PI) -ctx.setFillStyle('red') -ctx.fill() -// Draw arc -ctx.beginPath() -ctx.arc(100, 75, 50, 0, 1.5 * Math.PI) -ctx.setStrokeStyle('#333333') -ctx.stroke() -ctx.draw() -``` - -### arcTo - -根据控制点和半径绘制圆弧路径。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.arcTo.html) - -```tsx -(x1: number, y1: number, x2: number, y2: number, radius: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x1 | `number` | 第一个控制点的 x 轴坐标 | -| y1 | `number` | 第一个控制点的 y 轴坐标 | -| x2 | `number` | 第二个控制点的 x 轴坐标 | -| y2 | `number` | 第二个控制点的 y 轴坐标 | -| radius | `number` | 圆弧的半径 | - -### beginPath - -开始创建一个路径。需要调用 `fill` 或者 `stroke` 才会使用路径进行填充或描边 - - - 在最开始的时候相当于调用了一次 `beginPath`。 - - 同一个路径内的多次 `setFillStyle`、`setStrokeStyle`、`setLineWidth`等设置，以最后一次设置为准。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.beginPath.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// begin path -ctx.rect(10, 10, 100, 30) -ctx.setFillStyle('yellow') -ctx.fill() -// begin another path -ctx.beginPath() -ctx.rect(10, 40, 100, 30) -// only fill this rect, not in current path -ctx.setFillStyle('blue') -ctx.fillRect(10, 70, 100, 30) -ctx.rect(10, 100, 100, 30) -// it will fill current path -ctx.setFillStyle('red') -ctx.fill() -ctx.draw() -``` - -### bezierCurveTo - -创建三次方贝塞尔曲线路径。曲线的起始点为路径中前一个点。 - -针对 moveTo(20, 20) bezierCurveTo(20, 100, 200, 100, 200, 20) 的三个关键坐标如下： - -- 红色：起始点(20, 20) -- 蓝色：两个控制点(20, 100) (200, 100) -- 绿色：终止点(200, 20) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.bezierCurveTo.html) - -```tsx -(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cp1x | `number` | 第一个贝塞尔控制点的 x 坐标 | -| cp1y | `number` | 第一个贝塞尔控制点的 y 坐标 | -| cp2x | `number` | 第二个贝塞尔控制点的 x 坐标 | -| cp2y | `number` | 第二个贝塞尔控制点的 y 坐标 | -| x | `number` | 结束点的 x 坐标 | -| y | `number` | 结束点的 y 坐标 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Draw points -ctx.beginPath() -ctx.arc(20, 20, 2, 0, 2 * Math.PI) -ctx.setFillStyle('red') -ctx.fill() -ctx.beginPath() -ctx.arc(200, 20, 2, 0, 2 * Math.PI) -ctx.setFillStyle('lightgreen') -ctx.fill() -ctx.beginPath() -ctx.arc(20, 100, 2, 0, 2 * Math.PI) -ctx.arc(200, 100, 2, 0, 2 * Math.PI) -ctx.setFillStyle('blue') -ctx.fill() -ctx.setFillStyle('black') -ctx.setFontSize(12) -// Draw guides -ctx.beginPath() -ctx.moveTo(20, 20) -ctx.lineTo(20, 100) -ctx.lineTo(150, 75) -ctx.moveTo(200, 20) -ctx.lineTo(200, 100) -ctx.lineTo(70, 75) -ctx.setStrokeStyle('#AAAAAA') -ctx.stroke() -// Draw quadratic curve -ctx.beginPath() -ctx.moveTo(20, 20) -ctx.bezierCurveTo(20, 100, 200, 100, 200, 20) -ctx.setStrokeStyle('black') -ctx.stroke() -ctx.draw() -``` - -### clearRect - -清除画布上在该矩形区域内的内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.clearRect.html) - -```tsx -(x: number, y: number, width: number, height: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 矩形路径左上角的横坐标 | -| y | `number` | 矩形路径左上角的纵坐标 | -| width | `number` | 矩形路径的宽度 | -| height | `number` | 矩形路径的高度 | - -#### 示例代码 - -clearRect 并非画一个白色的矩形在地址区域，而是清空，为了有直观感受，对 canvas 加了一层背景色。 -```html - -``` -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(0, 0, 150, 200) -ctx.setFillStyle('blue') -ctx.fillRect(150, 0, 150, 200) -ctx.clearRect(10, 10, 150, 75) -ctx.draw() -``` - -### clip - -从原始画布中剪切任意形状和尺寸。一旦剪切了某个区域，则所有之后的绘图都会被限制在被剪切的区域内（不能访问画布上的其他区域）。可以在使用 `clip` 方法前通过使用 `save` 方法对当前画布区域进行保存，并在以后的任意时间通过`restore`方法对其进行恢复。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.clip.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -Taro.downloadFile({ - url: 'http://is5.mzstatic.com/image/thumb/Purple128/v4/75/3b/90/753b907c-b7fb-5877-215a-759bd73691a4/source/50x50bb.jpg', - success: function(res) { - ctx.save() - ctx.beginPath() - ctx.arc(50, 50, 25, 0, 2*Math.PI) - ctx.clip() - ctx.drawImage(res.tempFilePath, 25, 25) - ctx.restore() - ctx.draw() - } -}) -``` - -### closePath - -关闭一个路径。会连接起点和终点。如果关闭路径后没有调用 `fill` 或者 `stroke` 并开启了新的路径，那之前的路径将不会被渲染。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.closePath.html) - -```tsx -() => void -``` - -#### 示例代码 - -##### 示例 1 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.moveTo(10, 10) -ctx.lineTo(100, 10) -ctx.lineTo(100, 100) -ctx.closePath() -ctx.stroke() -ctx.draw() -``` - -##### 示例 2 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// begin path -ctx.rect(10, 10, 100, 30) -ctx.closePath() -// begin another path -ctx.beginPath() -ctx.rect(10, 40, 100, 30) -// only fill this rect, not in current path -ctx.setFillStyle('blue') -ctx.fillRect(10, 70, 100, 30) -ctx.rect(10, 100, 100, 30) -// it will fill current path -ctx.setFillStyle('red') -ctx.fill() -ctx.draw() -``` - -### createCircularGradient - -创建一个圆形的渐变颜色。起点在圆心，终点在圆环。返回的`CanvasGradient`对象需要使用 [CanvasGradient.addColorStop()](/docs/apis/canvas/CanvasGradient#addcolorstop) 来指定渐变点，至少要两个。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.createCircularGradient.html) - -```tsx -(x: number, y: number, r: number) => CanvasGradient -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 圆心的 x 坐标 | -| y | `number` | 圆心的 y 坐标 | -| r | `number` | 圆的半径 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Create circular gradient -const grd = ctx.createCircularGradient(75, 50, 50) -grd.addColorStop(0, 'red') -grd.addColorStop(1, 'white') -// Fill with gradient -ctx.setFillStyle(grd) -ctx.fillRect(10, 10, 150, 80) -ctx.draw() -``` - -### createLinearGradient - -创建一个线性的渐变颜色。返回的`CanvasGradient`对象需要使用 [CanvasGradient.addColorStop()](/docs/apis/canvas/CanvasGradient#addcolorstop) 来指定渐变点，至少要两个。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.createLinearGradient.html) - -```tsx -(x0: number, y0: number, x1: number, y1: number) => CanvasGradient -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x0 | `number` | 起点的 x 坐标 | -| y0 | `number` | 起点的 y 坐标 | -| x1 | `number` | 终点的 x 坐标 | -| y1 | `number` | 终点的 y 坐标 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Create linear gradient -const grd = ctx.createLinearGradient(0, 0, 200, 0) -grd.addColorStop(0, 'red') -grd.addColorStop(1, 'white') -// Fill with gradient -ctx.setFillStyle(grd) -ctx.fillRect(10, 10, 150, 80) -ctx.draw() -``` - -### createPattern - -对指定的图像创建模式的方法，可在指定的方向上重复元图像 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.createPattern.html) - -```tsx -(image: string, repetition: keyof Repetition) => CanvasPattern | Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| image | `string` | 重复的图像源，仅支持包内路径和临时路径 | -| repetition | `keyof Repetition` | 如何重复图像 | - -### draw - -将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中。 - -支持情况： - -> H5: 第二次调用 draw 前需要等待上一次 draw 调用结束后再调用，否则新的一次 draw 调用栈不会清空而导致结果异常。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.draw.html) - -```tsx -(reserve?: boolean, callback?: (...args: any[]) => any) => void | Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| reserve | `boolean` | 本次绘制是否接着上一次绘制。即 reserve 参数为 false，则在本次调用绘制之前 native 层会先清空画布再继续绘制；若 reserve 参数为 true，则保留当前画布上的内容，本次调用 drawCanvas 绘制的内容覆盖在上面，默认 false。 | -| callback | `(...args: any[]) => any` | 绘制完成后执行的回调函数 | - -#### 示例代码 - -##### 示例 1 - -第二次 draw() reserve 为 true。所以保留了上一次的绘制结果，在上下文设置的 fillStyle 'red' 也变成了默认的 'black'。 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 100) -ctx.draw(false, () => { - ctx.fillRect(50, 50, 150, 100) - ctx.draw(true) -}) -``` - -##### 示例 2 - -第二次 draw() reserve 为 false。所以没有保留了上一次的绘制结果和在上下文设置的 fillStyle 'red'。 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 100) -ctx.draw(false, () => { - ctx.fillRect(50, 50, 150, 100) - ctx.draw() -}) -``` - -### drawImage - -绘制图像到画布 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.drawImage.html) - -```tsx -{ (imageResource: string, dx: number, dy: number): void; (imageResource: string, dx: number, dy: number, dWidth: number, dHeight: number): void; (imageResource: string, sx: number, sy: number, sWidth: number, sHeight: number, dx: number, dy: number, dWidth: number, dHeight: number): void; } -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| imageResource | `string` | 所要绘制的图片资源（网络图片要通过 getImageInfo / downloadFile 先下载） | -| sx | `number` | 需要绘制到画布中的，imageResource的矩形（裁剪）选择框的左上角 x 坐标 | -| sy | `number` | 需要绘制到画布中的，imageResource的矩形（裁剪）选择框的左上角 y 坐标 | -| sWidth | `number` | 需要绘制到画布中的，imageResource的矩形（裁剪）选择框的宽度 | -| sHeight | `number` | 需要绘制到画布中的，imageResource的矩形（裁剪）选择框的高度 | -| dx | `number` | imageResource的左上角在目标 canvas 上 x 轴的位置 | -| dy | `number` | imageResource的左上角在目标 canvas 上 y 轴的位置 | -| dWidth | `number` | 在目标画布上绘制imageResource的宽度，允许对绘制的imageResource进行缩放 | -| dHeight | `number` | 在目标画布上绘制imageResource的高度，允许对绘制的imageResource进行缩放 | - -#### 示例代码 - -##### 示例 1 - -有三个版本的写法： - -- drawImage(imageResource, dx, dy) -- drawImage(imageResource, dx, dy, dWidth, dHeight) -- drawImage(imageResource, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight) 从 1.9.0 起支持 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -Taro.chooseImage({ - success: function(res){ - ctx.drawImage(res.tempFilePaths[0], 0, 0, 150, 100) - ctx.draw() - } -}) -``` - -##### 示例 2 - -有三个版本的写法： - -- drawImage(imageResource, dx, dy) -- drawImage(imageResource, dx, dy, dWidth, dHeight) -- drawImage(imageResource, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight) 从 1.9.0 起支持 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -Taro.chooseImage({ - success: function(res){ - ctx.drawImage(res.tempFilePaths[0], 0, 0, 150, 100) - ctx.draw() - } -}) -``` - -##### 示例 3 - -有三个版本的写法： - -- drawImage(imageResource, dx, dy) -- drawImage(imageResource, dx, dy, dWidth, dHeight) -- drawImage(imageResource, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight) 从 1.9.0 起支持 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -Taro.chooseImage({ - success: function(res){ - ctx.drawImage(res.tempFilePaths[0], 0, 0, 150, 100) - ctx.draw() - } -}) -``` - -### fill - -对当前路径中的内容进行填充。默认的填充色为黑色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.fill.html) - -```tsx -() => void -``` - -#### 示例代码 - -##### 示例 1 - -如果当前路径没有闭合，fill() 方法会将起点和终点进行连接，然后填充。 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.moveTo(10, 10) -ctx.lineTo(100, 10) -ctx.lineTo(100, 100) -ctx.fill() -ctx.draw() -``` - -##### 示例 2 - -fill() 填充的的路径是从 beginPath() 开始计算，但是不会将 fillRect() 包含进去。 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// begin path -ctx.rect(10, 10, 100, 30) -ctx.setFillStyle('yellow') -ctx.fill() -// begin another path -ctx.beginPath() -ctx.rect(10, 40, 100, 30) -// only fill this rect, not in current path -ctx.setFillStyle('blue') -ctx.fillRect(10, 70, 100, 30) -ctx.rect(10, 100, 100, 30) -// it will fill current path -ctx.setFillStyle('red') -ctx.fill() -ctx.draw() -``` - -### fillRect - -填充一个矩形。用 [`setFillStyle`](/docs/apis/canvas/CanvasContext#setfillstyle) 设置矩形的填充色，如果没设置默认是黑色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.fillRect.html) - -```tsx -(x: number, y: number, width: number, height: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 矩形路径左上角的横坐标 | -| y | `number` | 矩形路径左上角的纵坐标 | -| width | `number` | 矩形路径的宽度 | -| height | `number` | 矩形路径的高度 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 75) -ctx.draw() -``` - -### fillText - -在画布上绘制被填充的文本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.fillText.html) - -```tsx -(text: string, x: number, y: number, maxWidth?: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| text | `string` | 在画布上输出的文本 | -| x | `number` | 绘制文本的左上角 x 坐标位置 | -| y | `number` | 绘制文本的左上角 y 坐标位置 | -| maxWidth | `number` | 需要绘制的最大宽度，可选 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFontSize(20) -ctx.fillText('Hello', 20, 20) -ctx.fillText('MINA', 100, 100) -ctx.draw() -``` - -### lineTo - -增加一个新点，然后创建一条从上次指定点到目标点的线。用 `stroke` 方法来画线条 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.lineTo.html) - -```tsx -(x: number, y: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 目标位置的 x 坐标 | -| y | `number` | 目标位置的 y 坐标 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.moveTo(10, 10) -ctx.rect(10, 10, 100, 50) -ctx.lineTo(110, 60) -ctx.stroke() -ctx.draw() -``` - -### measureText - -测量文本尺寸信息。目前仅返回文本宽度。同步接口。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.measureText.html) - -```tsx -(text: string) => TextMetrics -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| text | `string` | 要测量的文本 | - -### moveTo - -把路径移动到画布中的指定点，不创建线条。用 `stroke` 方法来画线条 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.moveTo.html) - -```tsx -(x: number, y: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 目标位置的 x 坐标 | -| y | `number` | 目标位置的 y 坐标 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.moveTo(10, 10) -ctx.lineTo(100, 10) -ctx.moveTo(10, 50) -ctx.lineTo(100, 50) -ctx.stroke() -ctx.draw() -``` - -### quadraticCurveTo - -创建二次贝塞尔曲线路径。曲线的起始点为路径中前一个点。 - -针对 moveTo(20, 20) quadraticCurveTo(20, 100, 200, 20) 的三个关键坐标如下： - -- 红色：起始点(20, 20) -- 蓝色：控制点(20, 100) -- 绿色：终止点(200, 20) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.quadraticCurveTo.html) - -```tsx -(cpx: number, cpy: number, x: number, y: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cpx | `number` | 贝塞尔控制点的 x 坐标 | -| cpy | `number` | 贝塞尔控制点的 y 坐标 | -| x | `number` | 结束点的 x 坐标 | -| y | `number` | 结束点的 y 坐标 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Draw points -ctx.beginPath() -ctx.arc(20, 20, 2, 0, 2 * Math.PI) -ctx.setFillStyle('red') -ctx.fill() -ctx.beginPath() -ctx.arc(200, 20, 2, 0, 2 * Math.PI) -ctx.setFillStyle('lightgreen') -ctx.fill() -ctx.beginPath() -ctx.arc(20, 100, 2, 0, 2 * Math.PI) -ctx.setFillStyle('blue') -ctx.fill() -ctx.setFillStyle('black') -ctx.setFontSize(12) -// Draw guides -ctx.beginPath() -ctx.moveTo(20, 20) -ctx.lineTo(20, 100) -ctx.lineTo(200, 20) -ctx.setStrokeStyle('#AAAAAA') -ctx.stroke() -// Draw quadratic curve -ctx.beginPath() -ctx.moveTo(20, 20) -ctx.quadraticCurveTo(20, 100, 200, 20) -ctx.setStrokeStyle('black') -ctx.stroke() -ctx.draw() -``` - -### rect - -创建一个矩形路径。需要用 [`fill`](/docs/apis/canvas/CanvasContext#fill) 或者 [`stroke`](/docs/apis/canvas/CanvasContext#stroke) 方法将矩形真正的画到 `canvas` 中 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.rect.html) - -```tsx -(x: number, y: number, width: number, height: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 矩形路径左上角的横坐标 | -| y | `number` | 矩形路径左上角的纵坐标 | -| width | `number` | 矩形路径的宽度 | -| height | `number` | 矩形路径的高度 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.rect(10, 10, 150, 75) -ctx.setFillStyle('red') -ctx.fill() -ctx.draw() -``` - -### reset - -重置绘图上下文状态 - -支持情况： - -> [参考文档](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/reset) - -```tsx -() => void -``` - -### restore - -恢复之前保存的绘图上下文 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.restore.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// save the default fill style -ctx.save() -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 100) -// restore to the previous saved state -ctx.restore() -ctx.fillRect(50, 50, 150, 100) -ctx.draw() -``` - -### rotate - -以原点为中心顺时针旋转当前坐标轴。多次调用旋转的角度会叠加。原点可以用 `translate` 方法修改。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.rotate.html) - -```tsx -(rotate: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| rotate | `number` | 旋转角度，以弧度计 degrees * Math.PI/180；degrees 范围为 0-360 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.strokeRect(100, 10, 150, 100) -ctx.rotate(20 * Math.PI / 180) -ctx.strokeRect(100, 10, 150, 100) -ctx.rotate(20 * Math.PI / 180) -ctx.strokeRect(100, 10, 150, 100) -ctx.draw() -``` - -### save - -保存绘图上下文。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.save.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// save the default fill style -ctx.save() -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 100) -// restore to the previous saved state -ctx.restore() -ctx.fillRect(50, 50, 150, 100) -ctx.draw() -``` - -### scale - -在调用后，之后创建的路径其横纵坐标会被缩放。多次调用倍数会相乘。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.scale.html) - -```tsx -(scaleWidth: number, scaleHeight: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scaleWidth | `number` | 横坐标缩放的倍数 (1 = 100%，0.5 = 50%，2 = 200%) | -| scaleHeight | `number` | 纵坐标轴缩放的倍数 (1 = 100%，0.5 = 50%，2 = 200%) | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.strokeRect(10, 10, 25, 15) -ctx.scale(2, 2) -ctx.strokeRect(10, 10, 25, 15) -ctx.scale(2, 2) -ctx.strokeRect(10, 10, 25, 15) -ctx.draw() -``` - -### setFillStyle - -设置填充色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setFillStyle.html) - -```tsx -(color: string | CanvasGradient) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| color | string or CanvasGradient | 填充的颜色，默认颜色为 black。 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 75) -ctx.draw() -``` - -### setFontSize - -设置字体的字号 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setFontSize.html) - -```tsx -(fontSize: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fontSize | `number` | 字体的字号 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFontSize(20) -ctx.fillText('20', 20, 20) -ctx.setFontSize(30) -ctx.fillText('30', 40, 40) -ctx.setFontSize(40) -ctx.fillText('40', 60, 60) -ctx.setFontSize(50) -ctx.fillText('50', 90, 90) -ctx.draw() -``` - -### setGlobalAlpha - -设置全局画笔透明度。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setGlobalAlpha.html) - -```tsx -(alpha: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| alpha | `number` | 透明度。范围 0-1，0 表示完全透明，1 表示完全不透明。 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.fillRect(10, 10, 150, 100) -ctx.setGlobalAlpha(0.2) -ctx.setFillStyle('blue') -ctx.fillRect(50, 50, 150, 100) -ctx.setFillStyle('yellow') -ctx.fillRect(100, 100, 150, 100) -ctx.draw() -``` - -### setLineCap - -设置线条的端点样式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setLineCap.html) - -```tsx -(lineCap: keyof LineCap) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lineCap | `keyof LineCap` | 线条的结束端点样式 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.beginPath() -ctx.moveTo(10, 10) -ctx.lineTo(150, 10) -ctx.stroke() -ctx.beginPath() -ctx.setLineCap('butt') -ctx.setLineWidth(10) -ctx.moveTo(10, 30) -ctx.lineTo(150, 30) -ctx.stroke() -ctx.beginPath() -ctx.setLineCap('round') -ctx.setLineWidth(10) -ctx.moveTo(10, 50) -ctx.lineTo(150, 50) -ctx.stroke() -ctx.beginPath() -ctx.setLineCap('square') -ctx.setLineWidth(10) -ctx.moveTo(10, 70) -ctx.lineTo(150, 70) -ctx.stroke() -ctx.draw() -``` - -### setLineDash - -设置虚线样式。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setLineDash.html) - -```tsx -(pattern: number[], offset: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| pattern | `number[]` | 一组描述交替绘制线段和间距（坐标空间单位）长度的数字 | -| offset | `number` | 虚线偏移量 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setLineDash([10, 20], 5); -ctx.beginPath(); -ctx.moveTo(0,100); -ctx.lineTo(400, 100); -ctx.stroke(); -ctx.draw() -``` - -### setLineJoin - -设置线条的交点样式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setLineJoin.html) - -```tsx -(lineJoin: keyof LineJoin) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lineJoin | `keyof LineJoin` | 线条的结束交点样式 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.beginPath() -ctx.moveTo(10, 10) -ctx.lineTo(100, 50) -ctx.lineTo(10, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineJoin('bevel') -ctx.setLineWidth(10) -ctx.moveTo(50, 10) -ctx.lineTo(140, 50) -ctx.lineTo(50, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineJoin('round') -ctx.setLineWidth(10) -ctx.moveTo(90, 10) -ctx.lineTo(180, 50) -ctx.lineTo(90, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineJoin('miter') -ctx.setLineWidth(10) -ctx.moveTo(130, 10) -ctx.lineTo(220, 50) -ctx.lineTo(130, 90) -ctx.stroke() -ctx.draw() -``` - -### setLineWidth - -设置线条的宽度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setLineWidth.html) - -```tsx -(lineWidth: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lineWidth | `number` | 线条的宽度，单位px | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.beginPath() -ctx.moveTo(10, 10) -ctx.lineTo(150, 10) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(5) -ctx.moveTo(10, 30) -ctx.lineTo(150, 30) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(10) -ctx.moveTo(10, 50) -ctx.lineTo(150, 50) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(15) -ctx.moveTo(10, 70) -ctx.lineTo(150, 70) -ctx.stroke() -ctx.draw() -``` - -### setMiterLimit - -设置最大斜接长度。斜接长度指的是在两条线交汇处内角和外角之间的距离。当 [CanvasContext.setLineJoin()](/docs/apis/canvas/CanvasContext#setlinejoin) 为 miter 时才有效。超过最大倾斜长度的，连接处将以 lineJoin 为 bevel 来显示。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setMiterLimit.html) - -```tsx -(miterLimit: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| miterLimit | `number` | 最大斜接长度 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.beginPath() -ctx.setLineWidth(10) -ctx.setLineJoin('miter') -ctx.setMiterLimit(1) -ctx.moveTo(10, 10) -ctx.lineTo(100, 50) -ctx.lineTo(10, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(10) -ctx.setLineJoin('miter') -ctx.setMiterLimit(2) -ctx.moveTo(50, 10) -ctx.lineTo(140, 50) -ctx.lineTo(50, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(10) -ctx.setLineJoin('miter') -ctx.setMiterLimit(3) -ctx.moveTo(90, 10) -ctx.lineTo(180, 50) -ctx.lineTo(90, 90) -ctx.stroke() -ctx.beginPath() -ctx.setLineWidth(10) -ctx.setLineJoin('miter') -ctx.setMiterLimit(4) -ctx.moveTo(130, 10) -ctx.lineTo(220, 50) -ctx.lineTo(130, 90) -ctx.stroke() -ctx.draw() -``` - -### setShadow - -设定阴影样式。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setShadow.html) - -```tsx -(offsetX: number, offsetY: number, blur: number, color: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| offsetX | `number` | 阴影相对于形状在水平方向的偏移，默认值为 0。 | -| offsetY | `number` | 阴影相对于形状在竖直方向的偏移，默认值为 0。 | -| blur | `number` | 阴影的模糊级别，数值越大越模糊。范围 0- 100。，默认值为 0。 | -| color | `string` | 阴影的颜色。默认值为 black。 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setFillStyle('red') -ctx.setShadow(10, 50, 50, 'blue') -ctx.fillRect(10, 10, 150, 75) -ctx.draw() -``` - -### setStrokeStyle - -设置描边颜色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setStrokeStyle.html) - -```tsx -(color: string | CanvasGradient) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| color | string or CanvasGradient | 描边的颜色，默认颜色为 black。 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setStrokeStyle('red') -ctx.strokeRect(10, 10, 150, 75) -ctx.draw() -``` - -### setTextAlign - -设置文字的对齐 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setTextAlign.html) - -```tsx -(align: keyof Align) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| align | `keyof Align` | 文字的对齐方式 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setStrokeStyle('red') -ctx.moveTo(150, 20) -ctx.lineTo(150, 170) -ctx.stroke() -ctx.setFontSize(15) -ctx.setTextAlign('left') -ctx.fillText('textAlign=left', 150, 60) -await ctx.draw(true) -ctx.setTextAlign('center') -ctx.fillText('textAlign=center', 150, 80) -await ctx.draw(true) -ctx.setTextAlign('right') -ctx.fillText('textAlign=right', 150, 100) -await ctx.draw(true) -``` - -### setTextBaseline - -设置文字的竖直对齐 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setTextBaseline.html) - -```tsx -(textBaseline: keyof TextBaseline) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| textBaseline | `keyof TextBaseline` | 文字的竖直对齐方式 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setStrokeStyle('red') -ctx.moveTo(5, 75) -ctx.lineTo(295, 75) -ctx.stroke() -ctx.setFontSize(20) -ctx.setTextBaseline('top') -ctx.fillText('top', 5, 75) -await ctx.draw(true) -ctx.setTextBaseline('middle') -ctx.fillText('middle', 50, 75) -await ctx.draw(true) -ctx.setTextBaseline('bottom') -ctx.fillText('bottom', 120, 75) -await ctx.draw(true) -ctx.setTextBaseline('normal') -ctx.fillText('normal', 200, 75) -await ctx.draw(true) -``` - -### setTransform - -使用矩阵重新设置（覆盖）当前变换的方法 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.setTransform.html) - -```tsx -(scaleX: number, scaleY: number, skewX: number, skewY: number, translateX: number, translateY: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scaleX | `number` | 水平缩放 | -| scaleY | `number` | 垂直缩放 | -| skewX | `number` | 水平倾斜 | -| skewY | `number` | 垂直倾斜 | -| translateX | `number` | 水平移动 | -| translateY | `number` | 垂直移动 | - -### stroke - -画出当前路径的边框。默认颜色色为黑色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.stroke.html) - -```tsx -() => void -``` - -#### 示例代码 - -##### 示例 1 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.moveTo(10, 10) -ctx.lineTo(100, 10) -ctx.lineTo(100, 100) -ctx.stroke() -ctx.draw() -``` - -##### 示例 2 - -stroke() 描绘的的路径是从 beginPath() 开始计算，但是不会将 strokeRect() 包含进去。 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// begin path -ctx.rect(10, 10, 100, 30) -ctx.setStrokeStyle('yellow') -ctx.stroke() -// begin another path -ctx.beginPath() -ctx.rect(10, 40, 100, 30) -// only stoke this rect, not in current path -ctx.setStrokeStyle('blue') -ctx.strokeRect(10, 70, 100, 30) -ctx.rect(10, 100, 100, 30) -// it will stroke current path -ctx.setStrokeStyle('red') -ctx.stroke() -ctx.draw() -``` - -### strokeRect - -画一个矩形(非填充)。 用 [`setStrokeStyle`](/docs/apis/canvas/CanvasContext#setstrokestyle) 设置矩形线条的颜色，如果没设置默认是黑色。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.strokeRect.html) - -```tsx -(x: number, y: number, width: number, height: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 矩形路径左上角的横坐标 | -| y | `number` | 矩形路径左上角的纵坐标 | -| width | `number` | 矩形路径的宽度 | -| height | `number` | 矩形路径的高度 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.setStrokeStyle('red') -ctx.strokeRect(10, 10, 150, 75) -ctx.draw() -``` - -### strokeText - -给定的 (x, y) 位置绘制文本描边的方法 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.strokeText.html) - -```tsx -(text: string, x: number, y: number, maxWidth?: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| text | `string` | 要绘制的文本 | -| x | `number` | 文本起始点的 x 轴坐标 | -| y | `number` | 文本起始点的 y 轴坐标 | -| maxWidth | `number` | 需要绘制的最大宽度，可选 | - -### transform - -使用矩阵多次叠加当前变换的方法 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.transform.html) - -```tsx -(scaleX: number, scaleY: number, skewX: number, skewY: number, translateX: number, translateY: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scaleX | `number` | 水平缩放 | -| scaleY | `number` | 垂直缩放 | -| skewX | `number` | 水平倾斜 | -| skewY | `number` | 垂直倾斜 | -| translateX | `number` | 水平移动 | -| translateY | `number` | 垂直移动 | - -### translate - -对当前坐标系的原点 (0, 0) 进行变换。默认的坐标系原点为页面左上角。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasContext.translate.html) - -```tsx -(x: number, y: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 水平坐标平移量 | -| y | `number` | 竖直坐标平移量 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -ctx.strokeRect(10, 10, 150, 100) -ctx.translate(20, 20) -ctx.strokeRect(10, 10, 150, 100) -ctx.translate(20, 20) -ctx.strokeRect(10, 10, 150, 100) -ctx.draw() -``` - -## 参数 - -### Repetition - -参数 repetition 可选值 - -| 参数 | 说明 | -| --- | --- | -| repeat | 水平竖直方向都重复 | -| repeat-x | 水平方向重复 | -| repeat-y | 竖直方向重复 | -| no-repeat | 不重复 | - -### LineCap - -参数 lineCap 可选值 - -| 参数 | 说明 | -| --- | --- | -| butt | 向线条的每个末端添加平直的边缘。 | -| round | 向线条的每个末端添加圆形线帽。 | -| square | 向线条的每个末端添加正方形线帽。 | - -### LineJoin - -参数 lineJoin 可选值 - -| 参数 | 说明 | -| --- | --- | -| bevel | 斜角 | -| round | 圆角 | -| miter | 尖角 | - -### Align - -参数 align 可选值 - -| 参数 | 说明 | -| --- | --- | -| left | 左对齐 | -| center | 居中对齐 | -| right | 右对齐 | - -### TextBaseline - -参数 textBaseline 可选值 - -| 参数 | 说明 | -| --- | --- | -| top | 顶部对齐 | -| bottom | 底部对齐 | -| middle | 居中对齐 | -| normal | | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| CanvasContext.arc | ✔️ | ✔️ | | | -| CanvasContext.arcTo | ✔️ | ✔️ | | | -| CanvasContext.beginPath | ✔️ | ✔️ | | | -| CanvasContext.bezierCurveTo | ✔️ | ✔️ | | | -| CanvasContext.clearRect | ✔️ | ✔️ | | | -| CanvasContext.clip | ✔️ | ✔️ | | | -| CanvasContext.closePath | ✔️ | ✔️ | | | -| CanvasContext.createCircularGradient | ✔️ | ✔️ | | | -| CanvasContext.createLinearGradient | ✔️ | ✔️ | | | -| CanvasContext.createPattern | ✔️ | ✔️ | | | -| CanvasContext.draw | ✔️ | ✔️(第二次调用 draw 前需要等待上一次 draw 调用结束后再调用，否则新的一次 draw 调用栈不会清空而导致结果异常。) | | | -| CanvasContext.drawImage | ✔️ | ✔️ | | | -| CanvasContext.fill | ✔️ | ✔️ | | | -| CanvasContext.fillRect | ✔️ | ✔️ | | | -| CanvasContext.fillText | ✔️ | ✔️ | | | -| CanvasContext.lineTo | ✔️ | ✔️ | | | -| CanvasContext.measureText | ✔️ | ✔️ | | | -| CanvasContext.moveTo | ✔️ | ✔️ | | | -| CanvasContext.quadraticCurveTo | ✔️ | ✔️ | | | -| CanvasContext.rect | ✔️ | ✔️ | | | -| CanvasContext.reset | | ✔️ | | | -| CanvasContext.restore | ✔️ | ✔️ | | | -| CanvasContext.rotate | ✔️ | ✔️ | | | -| CanvasContext.save | ✔️ | ✔️ | | | -| CanvasContext.scale | ✔️ | ✔️ | | | -| CanvasContext.setFillStyle | ✔️ | ✔️ | | | -| CanvasContext.setFontSize | ✔️ | ✔️ | | | -| CanvasContext.setGlobalAlpha | ✔️ | ✔️ | | | -| CanvasContext.setLineCap | ✔️ | ✔️ | | | -| CanvasContext.setLineDash | ✔️ | ✔️ | | | -| CanvasContext.setLineJoin | ✔️ | ✔️ | | | -| CanvasContext.setLineWidth | ✔️ | ✔️ | | | -| CanvasContext.setMiterLimit | ✔️ | ✔️ | | | -| CanvasContext.setShadow | ✔️ | ✔️ | | | -| CanvasContext.setStrokeStyle | ✔️ | ✔️ | | | -| CanvasContext.setTextAlign | ✔️ | ✔️ | | | -| CanvasContext.setTextBaseline | ✔️ | ✔️ | | | -| CanvasContext.setTransform | ✔️ | ✔️ | | | -| CanvasContext.stroke | ✔️ | ✔️ | | | -| CanvasContext.strokeRect | ✔️ | ✔️ | | | -| CanvasContext.strokeText | ✔️ | ✔️ | | | -| CanvasContext.transform | ✔️ | ✔️ | | | -| CanvasContext.translate | ✔️ | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/canvas/CanvasGradient.md b/versioned_docs/version-4.x/apis/canvas/CanvasGradient.md deleted file mode 100644 index 74617c8ed14f..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/CanvasGradient.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CanvasGradient -sidebar_label: CanvasGradient ---- - -创建 canvas 的绘图上下文 CanvasContext 对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasGradient.html) - -## 方法 - -### addColorStop - -添加颜色的渐变点。小于最小 stop 的部分会按最小 stop 的 color 来渲染，大于最大 stop 的部分会按最大 stop 的 color 来渲染 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/CanvasGradient.addColorStop.html) - -```tsx -(stop: number, color: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| stop | `number` | 表示渐变中开始与结束之间的位置，范围 0-1。 | -| color | `string` | 渐变点的颜色。 | - -#### 示例代码 - -```tsx -const ctx = Taro.createCanvasContext('myCanvas') -// Create circular gradient -const grd = ctx.createLinearGradient(30, 10, 120, 10) -grd.addColorStop(0, 'red') -grd.addColorStop(0.16, 'orange') -grd.addColorStop(0.33, 'yellow') -grd.addColorStop(0.5, 'green') -grd.addColorStop(0.66, 'cyan') -grd.addColorStop(0.83, 'blue') -grd.addColorStop(1, 'purple') -// Fill with gradient -ctx.setFillStyle(grd) -ctx.fillRect(10, 10, 150, 80) -ctx.draw() -``` - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| CanvasGradient | ✔️ | | | | -| CanvasGradient.addColorStop | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/canvas/Color.md b/versioned_docs/version-4.x/apis/canvas/Color.md deleted file mode 100644 index d7048328c53d..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/Color.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: Color -sidebar_label: Color ---- - -颜色。可以用以下几种方式来表示 canvas 中使用的颜色： - -- RGB 颜色： 如 `'rgb(255, 0, 0)'` -- RGBA 颜色：如 `'rgba(255, 0, 0, 0.3)'` -- 16 进制颜色： 如 `'#FF0000'` -- 预定义的颜色： 如 `'red'` - -其中预定义颜色有以下148个： -*注意**: Color Name 大小写不敏感 - -| Color Name | HEX | -| -------------------- | ------- | -| AliceBlue | #F0F8FF | -| AntiqueWhite | #FAEBD7 | -| Aqua | #00FFFF | -| Aquamarine | #7FFFD4 | -| Azure | #F0FFFF | -| Beige | #F5F5DC | -| Bisque | #FFE4C4 | -| Black | #000000 | -| BlanchedAlmond | #FFEBCD | -| Blue | #0000FF | -| BlueViolet | #8A2BE2 | -| Brown | #A52A2A | -| BurlyWood | #DEB887 | -| CadetBlue | #5F9EA0 | -| Chartreuse | #7FFF00 | -| Chocolate | #D2691E | -| Coral | #FF7F50 | -| CornflowerBlue | #6495ED | -| Cornsilk | #FFF8DC | -| Crimson | #DC143C | -| Cyan | #00FFFF | -| DarkBlue | #00008B | -| DarkCyan | #008B8B | -| DarkGoldenRod | #B8860B | -| DarkGray | #A9A9A9 | -| DarkGrey | #A9A9A9 | -| DarkGreen | #006400 | -| DarkKhaki | #BDB76B | -| DarkMagenta | #8B008B | -| DarkOliveGreen | #556B2F | -| DarkOrange | #FF8C00 | -| DarkOrchid | #9932CC | -| DarkRed | #8B0000 | -| DarkSalmon | #E9967A | -| DarkSeaGreen | #8FBC8F | -| DarkSlateBlue | #483D8B | -| DarkSlateGray | #2F4F4F | -| DarkSlateGrey | #2F4F4F | -| DarkTurquoise | #00CED1 | -| DarkViolet | #9400D3 | -| DeepPink | #FF1493 | -| DeepSkyBlue | #00BFFF | -| DimGray | #696969 | -| DimGrey | #696969 | -| DodgerBlue | #1E90FF | -| FireBrick | #B22222 | -| FloralWhite | #FFFAF0 | -| ForestGreen | #228B22 | -| Fuchsia | #FF00FF | -| Gainsboro | #DCDCDC | -| GhostWhite | #F8F8FF | -| Gold | #FFD700 | -| GoldenRod | #DAA520 | -| Gray | #808080 | -| Grey | #808080 | -| Green | #008000 | -| GreenYellow | #ADFF2F | -| HoneyDew | #F0FFF0 | -| HotPink | #FF69B4 | -| IndianRed | #CD5C5C | -| Indigo | #4B0082 | -| Ivory | #FFFFF0 | -| Khaki | #F0E68C | -| Lavender | #E6E6FA | -| LavenderBlush | #FFF0F5 | -| LawnGreen | #7CFC00 | -| LemonChiffon | #FFFACD | -| LightBlue | #ADD8E6 | -| LightCoral | #F08080 | -| LightCyan | #E0FFFF | -| LightGoldenRodYellow | #FAFAD2 | -| LightGray | #D3D3D3 | -| LightGrey | #D3D3D3 | -| LightGreen | #90EE90 | -| LightPink | #FFB6C1 | -| LightSalmon | #FFA07A | -| LightSeaGreen | #20B2AA | -| LightSkyBlue | #87CEFA | -| LightSlateGray | #778899 | -| LightSlateGrey | #778899 | -| LightSteelBlue | #B0C4DE | -| LightYellow | #FFFFE0 | -| Lime | #00FF00 | -| LimeGreen | #32CD32 | -| Linen | #FAF0E6 | -| Magenta | #FF00FF | -| Maroon | #800000 | -| MediumAquaMarine | #66CDAA | -| MediumBlue | #0000CD | -| MediumOrchid | #BA55D3 | -| MediumPurple | #9370DB | -| MediumSeaGreen | #3CB371 | -| MediumSlateBlue | #7B68EE | -| MediumSpringGreen | #00FA9A | -| MediumTurquoise | #48D1CC | -| MediumVioletRed | #C71585 | -| MidnightBlue | #191970 | -| MintCream | #F5FFFA | -| MistyRose | #FFE4E1 | -| Moccasin | #FFE4B5 | -| NavajoWhite | #FFDEAD | -| Navy | #000080 | -| OldLace | #FDF5E6 | -| Olive | #808000 | -| OliveDrab | #6B8E23 | -| Orange | #FFA500 | -| OrangeRed | #FF4500 | -| Orchid | #DA70D6 | -| PaleGoldenRod | #EEE8AA | -| PaleGreen | #98FB98 | -| PaleTurquoise | #AFEEEE | -| PaleVioletRed | #DB7093 | -| PapayaWhip | #FFEFD5 | -| PeachPuff | #FFDAB9 | -| Peru | #CD853F | -| Pink | #FFC0CB | -| Plum | #DDA0DD | -| PowderBlue | #B0E0E6 | -| Purple | #800080 | -| RebeccaPurple | #663399 | -| Red | #FF0000 | -| RosyBrown | #BC8F8F | -| RoyalBlue | #4169E1 | -| SaddleBrown | #8B4513 | -| Salmon | #FA8072 | -| SandyBrown | #F4A460 | -| SeaGreen | #2E8B57 | -| SeaShell | #FFF5EE | -| Sienna | #A0522D | -| Silver | #C0C0C0 | -| SkyBlue | #87CEEB | -| SlateBlue | #6A5ACD | -| SlateGray | #708090 | -| SlateGrey | #708090 | -| Snow | #FFFAFA | -| SpringGreen | #00FF7F | -| SteelBlue | #4682B4 | -| Tan | #D2B48C | -| Teal | #008080 | -| Thistle | #D8BFD8 | -| Tomato | #FF6347 | -| Turquoise | #40E0D0 | -| Violet | #EE82EE | -| Wheat | #F5DEB3 | -| White | #FFFFFF | -| WhiteSmoke | #F5F5F5 | -| Yellow | #FFFF00 | -| YellowGreen | #9ACD32 | - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Color.html) diff --git a/versioned_docs/version-4.x/apis/canvas/Image.md b/versioned_docs/version-4.x/apis/canvas/Image.md deleted file mode 100644 index 9fa93b98c31e..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/Image.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Image -sidebar_label: Image ---- - -图片对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Image.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| src | `string` | 图片的 URL | -| height | `number` | 图片的真实高度 | -| width | `number` | 图片的真实宽度 | -| referrerPolicy | `string` | origin: 发送完整的referrer; no-referrer: 不发送。

格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本 | -| onerror | `(...args: any[]) => any` | 图片加载发生错误后触发的回调函数 | -| onload | `(...args: any[]) => any` | 图片加载完成后触发的回调函数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Image | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/canvas/ImageData.md b/versioned_docs/version-4.x/apis/canvas/ImageData.md deleted file mode 100644 index aa0c7ed37e33..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/ImageData.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: ImageData -sidebar_label: ImageData ---- - -ImageData 对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/ImageData.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 使用像素描述 ImageData 的实际宽度 | -| height | `number` | 使用像素描述 ImageData 的实际高度 | -| data | `Uint8ClampedArray` | 一维数组，包含以 RGBA 顺序的数据，数据使用 0 至 255（包含）的整数表示 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| ImageData | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/canvas/OffscreenCanvas.md b/versioned_docs/version-4.x/apis/canvas/OffscreenCanvas.md deleted file mode 100644 index 8bb6d441d590..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/OffscreenCanvas.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OffscreenCanvas -sidebar_label: OffscreenCanvas ---- - -离屏 canvas 实例，可通过 Taro.createOffscreenCanvas 创建。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/OffscreenCanvas.html) - -## 方法 - -### createImage - -创建一个图片对象。支持在 2D Canvas 和 WebGL Canvas 下使用, 但不支持混用 2D 和 WebGL 的方法 - -> 注意不允许混用 webgl 和 2d 画布创建的图片对象，使用时请注意尽量使用 canvas 自身的 createImage 创建图片对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/OffscreenCanvas.createImage.html) - -```tsx -() => Image -``` - -### getContext - -该方法返回 OffscreenCanvas 的绘图上下文 - -> 当前仅支持获取 WebGL 绘图上下文 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/OffscreenCanvas.getContext.html) - -```tsx -(contextType: string) => RenderingContext -``` - -| 参数 | 类型 | -| --- | --- | -| contextType | `string` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| OffscreenCanvas | ✔️ | | | | -| OffscreenCanvas.createImage | ✔️ | | | | -| OffscreenCanvas.getContext | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/canvas/Path2D.md b/versioned_docs/version-4.x/apis/canvas/Path2D.md deleted file mode 100644 index 3762887b6f9e..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/Path2D.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Path2D -sidebar_label: Path2D ---- - -Canvas 2D API 的接口 Path2D 用来声明路径，此路径稍后会被CanvasRenderingContext2D 对象使用。CanvasRenderingContext2D 接口的 路径方法 也存在于 Path2D 这个接口中，允许你在 canvas 中根据需要创建可以保留并重用的路径。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/Path2D.html) diff --git a/versioned_docs/version-4.x/apis/canvas/RenderingContext.md b/versioned_docs/version-4.x/apis/canvas/RenderingContext.md deleted file mode 100644 index b8d9eba1547c..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/RenderingContext.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RenderingContext -sidebar_label: RenderingContext ---- - -Canvas 绘图上下文。 - -**** - -- 通过 Canvas.getContext('2d') 接口可以获取 CanvasRenderingContext2D 对象，实现了 [HTML Canvas 2D Context](https://www.w3.org/TR/2dcontext/) 定义的属性、方法。 -- 通过 Canvas.getContext('webgl') 或 OffscreenCanvas.getContext('webgl') 接口可以获取 WebGLRenderingContext 对象，实现了 [WebGL 1.0](https://www.khronos.org/registry/webgl/specs/latest/1.0/) 定义的所有属性、方法、常量。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/RenderingContext.html) diff --git a/versioned_docs/version-4.x/apis/canvas/canvasGetImageData.md b/versioned_docs/version-4.x/apis/canvas/canvasGetImageData.md deleted file mode 100644 index 803373779699..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/canvasGetImageData.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Taro.canvasGetImageData(option, component) -sidebar_label: canvasGetImageData ---- - -获取 canvas 区域隐含的像素数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasGetImageData.html) - -## 类型 - -```tsx -(option: Option, component?: TaroGeneral.IAnyObject) => Promise -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| option | `Option` | | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 [canvas](/docs/components/canvas) 组件 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| canvasId | `string` | 是 | 画布标识，传入 [canvas](/docs/components/canvas) 组件的 `canvas-id` 属性。 | -| height | `number` | 是 | 将要被提取的图像数据矩形区域的高度 | -| width | `number` | 是 | 将要被提取的图像数据矩形区域的宽度 | -| x | `number` | 是 | 将要被提取的图像数据矩形区域的左上角横坐标 | -| y | `number` | 是 | 将要被提取的图像数据矩形区域的左上角纵坐标 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `Uint8ClampedArray` | 图像像素点数据，一维数组，每四项表示一个像素点的 rgba | -| height | `number` | 图像数据矩形的高度 | -| width | `number` | 图像数据矩形的宽度 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.canvasGetImageData({ - canvasId: 'myCanvas', - x: 0, - y: 0, - width: 100, - height: 100, - success: function (res) { - console.log(res.width) // 100 - console.log(res.height) // 100 - console.log(res.data instanceof Uint8ClampedArray) // true - console.log(res.data.length) // 100 * 100 * 4 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/canvas/canvasPutImageData.md b/versioned_docs/version-4.x/apis/canvas/canvasPutImageData.md deleted file mode 100644 index 8d99e3290f2b..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/canvasPutImageData.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.canvasPutImageData(option, component) -sidebar_label: canvasPutImageData ---- - -将像素数据绘制到画布。在自定义组件下，第二个参数传入自定义组件实例 this，以操作组件内 `` 组件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasPutImageData.html) - -## 类型 - -```tsx -(option: Option, component?: TaroGeneral.IAnyObject) => Promise -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| option | `Option` | | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 [canvas](/docs/components/canvas) 组件 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| canvasId | `string` | 是 | 画布标识，传入 [canvas](/docs/components/canvas) 组件的 canvas-id 属性。 | -| data | `Uint8ClampedArray` | 是 | 图像像素点数据，一维数组，每四项表示一个像素点的 rgba | -| height | `number` | 是 | 源图像数据矩形区域的高度 | -| width | `number` | 是 | 源图像数据矩形区域的宽度 | -| x | `number` | 是 | 源图像数据在目标画布中的位置偏移量（x 轴方向的偏移量） | -| y | `number` | 是 | 源图像数据在目标画布中的位置偏移量（y 轴方向的偏移量） | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -const data = new Uint8ClampedArray([255, 0, 0, 1]) -Taro.canvasPutImageData({ - canvasId: 'myCanvas', - x: 0, - y: 0, - width: 1, - data: data, - success: function (res) {} -}) -``` diff --git a/versioned_docs/version-4.x/apis/canvas/canvasToTempFilePath.md b/versioned_docs/version-4.x/apis/canvas/canvasToTempFilePath.md deleted file mode 100644 index af4e33eeff0a..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/canvasToTempFilePath.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Taro.canvasToTempFilePath(option, component) -sidebar_label: canvasToTempFilePath ---- - -把当前画布指定区域的内容导出生成指定大小的图片。在 `draw()` 回调里调用该方法才能保证图片导出成功。 - -**Bug & Tip：** - -1. `tip`: 在 `draw` 回调里调用该方法才能保证图片导出成功。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.html) - -## 类型 - -```tsx -(option: Option, component?: TaroGeneral.IAnyObject) => Promise -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| option | `Option` | | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 [canvas](/docs/components/canvas) 组件 | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| canvas | `Canvas` | | 否 | 画布标识，传入 [canvas](/docs/components/canvas) 组件实例 （canvas type="2d" 时使用该属性）。 | -| canvasId | `string` | | 否 | 画布标识，传入 [canvas](/docs/components/canvas) 组件的 canvas-id | -| quality | `number` | | 否 | 图片的质量，目前仅对 jpg 有效。取值范围为 (0, 1]，不在范围内时当作 1.0 处理。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| destHeight | `number` | | 否 | 输出的图片的高度 | -| destWidth | `number` | | 否 | 输出的图片的宽度 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| fileType | `keyof FileType` | `"png"` | 否 | 目标文件的类型 | -| height | `number` | | 否 | 指定的画布区域的高度 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| width | `number` | | 否 | 指定的画布区域的宽度 | -| x | `number` | | 否 | 指定的画布区域的左上角横坐标 | -| y | `number` | | 否 | 指定的画布区域的左上角纵坐标 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 生成文件的临时路径 | -| errMsg | `string` | 调用结果 | - -### FileType - -| 参数 | 说明 | -| --- | --- | -| jpg | jpg 图片 | -| png | png 图片 | - -### CanvasProps - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| type | `string` | | 否 | 指定 canvas 类型，支持 2d 和 webgl | -| canvasId | `string` | | 否 | canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性 | -| disableScroll | `boolean` | `false` | 否 | 当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新 | -| onTouchStart | `TaroGeneral.CommonEventFunction` | | 否 | 手指触摸动作开始 | -| onTouchMove | `TaroGeneral.CommonEventFunction` | | 否 | 手指触摸后移动 | -| onTouchEnd | `TaroGeneral.CommonEventFunction` | | 否 | 手指触摸动作结束 | -| onTouchCancel | `TaroGeneral.CommonEventFunction` | | 否 | 手指触摸动作被打断，如来电提醒，弹窗 | -| onLongTap | `TaroGeneral.CommonEventFunction` | | 否 | 手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动 | -| onError | `TaroGeneral.CommonEventFunction` | | 否 | 当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'} | - -#### onErrorEventDetail - -| 参数 | 类型 | -| --- | --- | -| errMsg | `string` | - -## 示例代码 - -```tsx -Taro.canvasToTempFilePath({ - x: 100, - y: 200, - width: 50, - height: 50, - destWidth: 100, - destHeight: 100, - canvasId: 'myCanvas', - success: function (res) { - console.log(res.tempFilePath) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/canvas/createCanvasContext.md b/versioned_docs/version-4.x/apis/canvas/createCanvasContext.md deleted file mode 100644 index db341dbfc505..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/createCanvasContext.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.createCanvasContext(canvasId, component) -sidebar_label: createCanvasContext ---- - -创建 canvas 的绘图上下文 [CanvasContext](/docs/apis/canvas/CanvasContext) 对象 - -**Tip**: 需要指定 canvasId，该绘图上下文只作用于对应的 ``；另外，Web 端需要在 `useReady` 回调中执行它，否则会因为底层 canvas 渲染出来之前而去获取 CanvasContext，导致其底层的 context 为 `undefined`，从而不能正常绘图。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.createCanvasContext.html) - -## 类型 - -```tsx -(canvasId: string, component?: TaroGeneral.IAnyObject) => CanvasContext -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| canvasId | `string` | 要获取上下文的 [canvas](/docs/components/canvas) 组件 canvas-id 属性 | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，表示在这个自定义组件下查找拥有 canvas-id 的 [canvas](/docs/components/canvas) ，如果省略则不在任何自定义组件内查找 | - -## 示例代码 - -```tsx -import { useReady } from '@tarojs/taro' - -useReady(() => { - const context = Taro.createCanvasContext('canvas') - context.setStrokeStyle("#00ff00") - context.setLineWidth(5) - context.rect(0, 0, 200, 200) - context.stroke() - context.setStrokeStyle("#ff0000") - context.setLineWidth(2) - context.moveTo(160, 100) - context.arc(100, 100, 60, 0, 2 * Math.PI, true) - context.moveTo(140, 100) - context.arc(100, 100, 40, 0, Math.PI, false) - context.moveTo(85, 80) - context.arc(80, 80, 5, 0, 2 * Math.PI, true) - context.moveTo(125, 80) - context.arc(120, 80, 5, 0, 2 * Math.PI, true) - context.stroke() - context.draw() -}) -``` diff --git a/versioned_docs/version-4.x/apis/canvas/createContext.md b/versioned_docs/version-4.x/apis/canvas/createContext.md deleted file mode 100644 index 60384c12082e..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/createContext.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Taro.createContext(不推荐使用) -sidebar_label: createContext ---- - - -创建并返回绘图上下文。 - -## API支持度 - -| API | 微信小程序 | H5 | React Native | -| :-: | :-: | :-: | :-: | -| Taro.createContext | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/canvas/createOffscreenCanvas.md b/versioned_docs/version-4.x/apis/canvas/createOffscreenCanvas.md deleted file mode 100644 index cb2043677a96..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/createOffscreenCanvas.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.createOffscreenCanvas(options) -sidebar_label: createOffscreenCanvas ---- - -创建离屏 canvas 实例 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.createOffscreenCanvas.html - -有两个版本的写法： - -- createOffscreenCanvas(options) 从 2.16.1 起支持 -- createOffscreenCanvas(width, height, this) 从 2.7.0 起支持) - -## 类型 - -```tsx -(options: Option) => OffscreenCanvas -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| options | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| type | "webgl" or "2d" | `: 'webgl'` | 否 | 创建的离屏 canvas 类型 | -| height | `number` | | 否 | 画布高度 | -| width | `number` | | 否 | 画布宽度 | -| component | `TaroGeneral.IAnyObject` | | 否 | 在自定义组件下，当前组件实例的 this，以操作组件内 [canvas](/docs/components/canvas) 组件 | diff --git a/versioned_docs/version-4.x/apis/canvas/drawCanvas.md b/versioned_docs/version-4.x/apis/canvas/drawCanvas.md deleted file mode 100644 index eeaadefe6df5..000000000000 --- a/versioned_docs/version-4.x/apis/canvas/drawCanvas.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Taro.drawCanvas(不推荐使用) -sidebar_label: drawCanvas ---- - - -使用方式同 [`wx.drawCanvas`](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/draw-canvas.html)。 - -## API支持度 - -| API | 微信小程序 | H5 | React Native | -| :-: | :-: | :-: | :-: | -| Taro.drawCanvas | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/cloud/DB.md b/versioned_docs/version-4.x/apis/cloud/DB.md deleted file mode 100644 index de2bd81664fb..000000000000 --- a/versioned_docs/version-4.x/apis/cloud/DB.md +++ /dev/null @@ -1,2843 +0,0 @@ ---- -title: DB -sidebar_label: DB ---- - -## 参数 - -### Database - -云开发 SDK 数据库实例 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Database.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| config | `IConfig` | 数据库配置 | -| command | `Command` | 数据库操作符，通过 db.command 获取
API 支持度: weapp
[参考地址](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Command.html) | -| Geo | `IGeo` | 数据库地理位置结构集
API 支持度: weapp
[参考地址](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Geo.html) | - -#### serverDate - -构造一个服务端时间的引用。可用于查询条件、更新字段值或新增记录时的字段值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Database.serverDate.html) - -```tsx -(options?: IOptions) => ServerDate -``` - -| 参数 | 类型 | -| --- | --- | -| options | `IOptions` | - -##### 示例代码 - -新增记录时设置字段为服务端时间： - -```tsx -db.collection('todos').add({ - description: 'eat an apple', - createTime: db.serverDate() -}) -``` -更新字段为服务端时间往后一小时： - -```tsx -db.collection('todos').doc('my-todo-id').update({ - due: db.serverDate({ - offset: 60 * 60 * 1000 - }) -}) -``` - -#### RegExp - -构造正则表达式，仅需在普通 js 正则表达式无法满足的情况下使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Database.RegExp.html) - -```tsx -(options: IRegExpOptions) => IRegExp -``` - -| 参数 | 类型 | -| --- | --- | -| options | `IRegExpOptions` | - -##### 示例代码 - -```tsx -// 原生 JavaScript 对象 -db.collection('todos').where({ - description: /miniprogram/i -}) - -// 数据库正则对象 -db.collection('todos').where({ - description: db.RegExp({ - regexp: 'miniprogram', - options: 'i', - }) -}) - -// 用 new 构造也是可以的 -db.collection('todos').where({ - description: new db.RegExp({ - regexp: 'miniprogram', - options: 'i', - }) -}) -``` - -#### collection - -获取集合的引用。方法接受一个 `name` 参数，指定需引用的集合名称。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Database.collection.html) - -```tsx -(collectionName: string) => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| collectionName | `string` | - -##### 示例代码 - -```tsx -const db = Taro.cloud.database() -const todosCollection = db.collection('todos') -``` - -#### ServerDate - -可用于查询条件、更新字段值或新增记录时的字段值。 - -| 参数 | 类型 | -| --- | --- | -| options | `IOptions` | - -##### IOptions - -| 参数 | 类型 | -| --- | --- | -| offset | `number` | - -#### IRegExp - -构造正则表达式 - -| 参数 | 类型 | -| --- | --- | -| regexp | `string` | -| options | `string` | - -##### IRegExpOptions - -| 参数 | 类型 | 必填 | -| --- | --- | :---: | -| regexp | `string` | 是 | -| options | `string` | 否 | - -#### InternalSymbol - -内部符号 - -### Collection - -数据库集合引用 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Collection.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| collectionName | `string` | 集合名称 | -| database | `Database` | 集合所在数据库引用 | - -#### doc - -获取集合中指定记录的引用。方法接受一个 `id` 参数，指定需引用的记录的 `_id`。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.doc.html) - -```tsx -(docId: string | number) => Document -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| docId | string or number | 记录 _id | - -##### 示例代码 - -```tsx -const myTodo = db.collection('todos').doc('my-todo-id') -``` - -#### aggregate - -发起聚合操作，定义完聚合流水线阶段之后需调用 end 方法标志结束定义并实际发起聚合操作 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.aggregate.html) - -```tsx -() => Aggregate -``` - -##### 示例代码 - -###### 示例 1 - -```tsx -const $ = db.command.aggregate -db.collection('books').aggregate() - .group({ - // 按 category 字段分组 - _id: '$category', - // 让输出的每组记录有一个 avgSales 字段，其值是组内所有记录的 sales 字段的平均值 - avgSales: $.avg('$sales') - }) - .end() - .then(res => console.log(res)) - .catch(err => console.error(err)) -``` - -###### 示例 2 - -```tsx -const $ = db.command.aggregate -db.collection('books').aggregate() - .group({ - // 按 category 字段分组 - _id: '$category', - // 让输出的每组记录有一个 avgSales 字段，其值是组内所有记录的 sales 字段的平均值 - avgSales: $.avg('$sales') - }) - .end({ - success: function(res) { - console.log(res) - }, - fail: function(err) { - console.error(err) - } - }) -``` - -#### where - -指定查询条件，返回带新查询条件的新的集合引用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.where.html) - -```tsx -(condition: IQueryCondition) => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| condition | `IQueryCondition` | - -##### 示例代码 - -```tsx -const _ = db.command -const result = await db.collection('todos').where({ - price: _.lt(100) -}).get() -``` - -#### limit - -指定查询结果集数量上限 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.limit.html) - -```tsx -(value: number) => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| value | `number` | - -##### 示例代码 - -```tsx -db.collection('todos').limit(10) - .get() - .then(console.log) - .catch(console.error) -``` - -#### orderBy - -指定查询排序条件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.orderBy.html) - -```tsx -(fieldPath: string, string: "asc" | "desc") => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| fieldPath | `string` | -| string | "asc" or "desc" | - -##### 示例代码 - -按一个字段排序：按进度排升序取待办事项 - -```tsx -db.collection('todos').orderBy('progress', 'asc') - .get() - .then(console.log) - .catch(console.error) -``` - -按多个字段排序：先按 progress 排降序（progress 越大越靠前）、再按 description 排升序（字母序越前越靠前）取待办事项 - -```tsx -db.collection('todos') - .orderBy('progress', 'desc') - .orderBy('description', 'asc') - .get() - .then(console.log) - .catch(console.error) -``` - -#### skip - -指定查询返回结果时从指定序列后的结果开始返回，常用于分页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.skip.html) - -```tsx -(offset: number) => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| offset | `number` | - -##### 示例代码 - -```tsx -db.collection('todos').skip(10) - .get() - .then(console.log) - .catch(console.error) -``` - -#### field - -指定返回结果中记录需返回的字段 - -**说明** - -方法接受一个必填对象用于指定需返回的字段，对象的各个 key 表示要返回或不要返回的字段，value 传入 true|false（或 1|-1）表示要返回还是不要返回。 -如果指定的字段是数组字段，还可以用以下方法只返回数组的第一个元素：在该字段 key 后面拼接上 `.$` 成为 `字段.$` 的形式。 -如果指定的字段是数组字段，还可以用 `db.command.project.slice` 方法返回数组的子数组： -方法既可以接收一个正数表示返回前 n 个元素，也可以接收一个负数表示返回后 n 个元素；还可以接收一个包含两个数字 `[ skip, limit ]` 的数组，如果 `skip` 是正数，表示跳过 `skip` 个元素后再返回接下来的 `limit` 个元素，如果 `skip` 是负数，表示从倒数第 `skip` 个元素开始，返回往后数的 `limit` 个元素 - -- 返回数组的前 5 个元素：`{ tags: db.command.project.slice(5) }` -- 返回数组的后 5 个元素：`{ tags: db.command.project.slice(-5) }` -- 跳过前 5 个元素，返回接下来 10 个元素：`{ tags: db.command.project.slice(5, 10) }` -- 从倒数第 5 个元素开始，返回接下来正方向数的 10 个元素：`{ tags: db.command.project.slice(-5, 10) }` - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.field.html) - -```tsx -(object: TaroGeneral.IAnyObject) => Collection -``` - -| 参数 | 类型 | -| --- | --- | -| object | `TaroGeneral.IAnyObject` | - -##### 示例代码 - -返回 description, done 和 progress 三个字段： - -```tsx -db.collection('todos').field({ - description: true, - done: true, - progress: true, - // 只返回 tags 数组前 3 个元素 - tags: db.command.project.slice(3), -}) - .get() - .then(console.log) - .catch(console.error) -``` - -#### get - -获取集合数据，或获取根据查询条件筛选后的集合数据。 - -**使用说明** - -统计集合记录数或统计查询语句对应的结果记录数 - -小程序端与云函数端的表现会有如下差异： - -- 小程序端：如果没有指定 limit，则默认且最多取 20 条记录。 -- 云函数端：如果没有指定 limit，则默认且最多取 100 条记录。 - -如果没有指定 skip，则默认从第 0 条记录开始取，skip 常用于分页。 - -如果需要取集合中所有的数据，仅在数据量不大且在云函数中时 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.get.html) - -```tsx -() => Promise -``` - -##### 示例代码 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).get().then(res => { - console.log(res.data) -}) -``` - -#### count - -统计匹配查询条件的记录的条数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.count.html) - -```tsx -() => Promise -``` - -##### 示例代码 - -###### 示例 1 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).count().then(res => { - console.log(res.total) -}) -``` - -###### 示例 2 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).count({ - success: function(res) { - console.log(res.total) - }, - fail: console.error -}) -``` - -#### add - -新增记录，如果传入的记录对象没有 _id 字段，则由后台自动生成 _id；若指定了 _id，则不能与已有记录冲突 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.add.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').add({ - // data 字段表示需新增的 JSON 数据 - data: { - description: "learn cloud database", - due: new Date("2018-09-01"), - tags: [ - "cloud", - "database" - ], - location: new db.Geo.Point(113, 23), - done: false - } -}) -.then(res => { - console.log(res) -}) -.catch(console.error) -``` - -###### 示例 2 - -```tsx -db.collection('todos').add({ - // data 字段表示需新增的 JSON 数据 - data: { - // _id: 'todo-identifiant-aleatoire', // 可选自定义 _id，在此处场景下用数据库自动分配的就可以了 - description: "learn cloud database", - due: new Date("2018-09-01"), - tags: [ - "cloud", - "database" - ], - // 为待办事项添加一个地理位置（113°E，23°N） - location: new db.Geo.Point(113, 23), - done: false - }, - success: function(res) { - // res 是一个对象，其中有 _id 字段标记刚创建的记录的 id - console.log(res) - }, - fail: console.error, - complete: cosnole.log -}) -``` - -#### watch - -监听集合中符合查询条件的数据的更新事件。注意使用 watch 时，只有 where 语句会生效，orderBy、limit 等不生效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.watch.html) - -```tsx -(options: IWatchDocumentOptions) => IWatcher -``` - -| 参数 | 类型 | -| --- | --- | -| options | `IWatchDocumentOptions` | - -##### 示例代码 - -###### 示例 1 - -根据查询条件监听 - -```tsx -const db = Taro.cloud.database() -const watcher = db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).watch({ - onChange: function(snapshot) { - console.log('snapshot', snapshot) - }, - onError: function(err) { - console.error('the watch closed because of error', err) - } -}) -``` - -###### 示例 2 - -监听一个记录的变化 - -```tsx -const db = Taro.cloud.database() -const watcher = db.collection('todos').doc('x').watch({ - onChange: function(snapshot) { - console.log('snapshot', snapshot) - }, - onError: function(err) { - console.error('the watch closed because of error', err) - } -}) -``` - -###### 示例 3 - -关闭监听 - -```tsx -const db = Taro.cloud.database() -const watcher = db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).watch({ - onChange: function(snapshot) { - console.log('snapshot', snapshot) - }, - onError: function(err) { - console.error('the watch closed because of error', err) - } -}) -// ... -// 关闭 -await watcher.close() -``` - -### Document - -数据库记录引用 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Document.html) - -#### get - -获取记录数据，或获取根据查询条件筛选后的记录数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/document/Document.get.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').doc('').get().then(res => { - console.log(res.data) -}) -``` - -###### 示例 2 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').doc('').get({ - success: function(res) { - console.log(res.data) - }, - fail: console.error -}) -``` - -#### set - -替换更新一条记 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/document/Document.set.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -const _ = db.command -db.collection('todos').doc('todo-identifiant-aleatoire').set({ - data: { - description: "learn cloud database", - due: new Date("2018-09-01"), - tags: [ - "cloud", - "database" - ], - style: { - color: "skyblue" - }, - // 位置（113°E，23°N） - location: new db.Geo.Point(113, 23), - done: false - } -}).then(res => { - console.log(res) -}).catch(err => { - console.error(err) -}) -``` - -###### 示例 2 - -```tsx -const _ = db.command -db.collection('todos').doc('todo-identifiant-aleatoire').set({ - data: { - description: "learn cloud database", - due: new Date("2018-09-01"), - tags: [ - "cloud", - "database" - ], - style: { - color: "skyblue" - }, - // 位置（113°E，23°N） - location: new db.Geo.Point(113, 23), - done: false - }, - success: function(res) { - console.log(res.data) - }, - fail: console.error -}) -``` - -#### update - -更新一条记录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/document/Document.update.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise<...>; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').doc('todo-identifiant-aleatoire').update({ - // data 传入需要局部更新的数据 - data: { - // 表示将 done 字段置为 true - done: true - } -}) -.then(console.log) -.catch(console.error) -``` - -###### 示例 2 - -db.collection('todos').doc('todo-identifiant-aleatoire').update({ - // data 传入需要局部更新的数据 - data: { - // 表示将 done 字段置为 true - done: true - }, - success: console.log, - fail: console.error -}) -``` - -#### remove - -删除一条记录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/document/Document.remove.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').doc('todo-identifiant-aleatoire').remove() - .then(console.log) - .catch(console.error) -``` - -###### 示例 2 - -```tsx -db.collection('todos').doc('todo-identifiant-aleatoire').remove({ - success: console.log, - fail: console.error -}) -``` - -#### DocumentId - -记录 ID - -#### IDocumentData - -记录结构 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| _id | `DocumentId` | 否 | 新增的记录 _id | -| __index | `__index` | 是 | | - -#### IDBAPIParam - -数据库 API 通用参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | -| success | `(res: T) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(err: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(val: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### IAddDocumentOptions - -新增记录的定义 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `IDocumentData` | 是 | 新增记录的定义 | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### IWatchDocumentOptions - -监听集合中符合查询条件的数据的更新事件 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| onChange | `(res: TaroGeneral.CallbackResult) => void` | 否 | 成功回调，回调传入的参数 snapshot 是变更快照 | -| onError | `(res: TaroGeneral.CallbackResult) => void` | 否 | 失败回调 | - -#### ISnapshot - -变更快照 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| docChanges | `ChangeEvent[]` | 更新事件数组 | -| docs | `TaroGeneral.IAnyObject[]` | 数据快照，表示此更新事件发生后查询语句对应的查询结果 | -| type | `string` | 快照类型，仅在第一次初始化数据时有值为 init | -| id | `number` | 变更事件 id | - -#### ChangeEvent - -更新事件 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `number` | 更新事件 id | -| queueType | `keyof QueueType` | 列表更新类型，表示更新事件对监听列表的影响，枚举值 | -| dataType | `keyof DataType` | 数据更新类型，表示记录的具体更新类型，枚举值 | -| docId | `string` | 更新的记录 id | -| doc | `TaroGeneral.IAnyObject` | 更新的完整记录 | -| updatedFields | `TaroGeneral.IAnyObject` | 所有更新的字段及字段更新后的值，`key` 为更新的字段路径，`value` 为字段更新后的值，仅在 `update` 操作时有此信息 | -| removedFields | `string[]` | 所有被删除的字段，仅在 `update` 操作时有此信息 | - -#### QueueType - -列表更新类型，表示更新事件对监听列表的影响，枚举值 - -| 参数 | 说明 | -| --- | --- | -| init | 初始化列表 | -| update | 列表中的记录内容有更新，但列表包含的记录不变 | -| enqueue | 记录进入列表 | -| dequeue | 记录离开列表 | - -#### DataType - -数据更新类型，表示记录的具体更新类型，枚举值 - -| 参数 | 说明 | -| --- | --- | -| init | 初始化列表 | -| update | 记录内容更新，对应 `update` 操作 | -| replace | 记录内容被替换，对应 `set` 操作 | -| add | 记录新增，对应 `add` 操作 | -| remove | 记录被删除，对应 `remove` 操作 | - -#### IWatcher - -##### close - -关闭监听，无需参数，返回 Promise，会在关闭完成时 resolve - -```tsx -() => Promise -``` - -#### IGetDocumentOptions - -获取记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | -| success | `(res: T) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(err: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(val: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### ICountDocumentOptions - -获取记录条数参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | -| success | `(res: T) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(err: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(val: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### IUpdateDocumentOptions - -更新记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `IUpdateCondition` | 是 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### IUpdateSingleDocumentOptions - -更新单条记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `IUpdateCondition` | 是 | 替换记录的定义 | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### ISetDocumentOptions - -替换记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `IUpdateCondition` | 是 | 替换记录的定义 | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### ISetSingleDocumentOptions - -替换一条记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `IUpdateCondition` | 是 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### IRemoveDocumentOptions - -删除记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| query | `IQueryCondition` | 是 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### IRemoveSingleDocumentOptions - -删除一条记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | -| success | `(res: T) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(err: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(val: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -#### IUpdateCondition - -更新记录定义 - -| 参数 | 类型 | -| --- | --- | -| __index | `__index` | - -### Query - -数据库 Query 引用 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Query.html) - -#### where - -指定查询条件，返回带新查询条件的新的集合引用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.where.html) - -```tsx -(condition: IQueryCondition) => Query -``` - -| 参数 | 类型 | -| --- | --- | -| condition | `IQueryCondition` | - -##### 示例代码 - -```tsx -const _ = db.command -const result = await db.collection('todos').where({ - price: _.lt(100) -}).get() -``` - -#### orderBy - -指定查询排序条件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.orderBy.html) - -```tsx -(fieldPath: string, order: string) => Query -``` - -| 参数 | 类型 | -| --- | --- | -| fieldPath | `string` | -| order | `string` | - -##### 示例代码 - -按一个字段排序：按进度排升序取待办事项 - -```tsx -db.collection('todos').orderBy('progress', 'asc') - .get() - .then(console.log) - .catch(console.error) -``` - -按多个字段排序：先按 progress 排降序（progress 越大越靠前）、再按 description 排升序（字母序越前越靠前）取待办事项 - -```tsx -db.collection('todos') - .orderBy('progress', 'desc') - .orderBy('description', 'asc') - .get() - .then(console.log) - .catch(console.error) -``` - -#### limit - -指定查询结果集数量上限 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.limit.html) - -```tsx -(max: number) => Query -``` - -| 参数 | 类型 | -| --- | --- | -| max | `number` | - -##### 示例代码 - -```tsx -db.collection('todos').limit(10) - .get() - .then(console.log) - .catch(console.error) -``` - -#### skip - -指定查询返回结果时从指定序列后的结果开始返回，常用于分页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.skip.html) - -```tsx -(offset: number) => Query -``` - -| 参数 | 类型 | -| --- | --- | -| offset | `number` | - -##### 示例代码 - -```tsx -db.collection('todos').skip(10) - .get() - .then(console.log) - .catch(console.error) -``` - -#### field - -指定返回结果中记录需返回的字段 - -**说明** - -方法接受一个必填对象用于指定需返回的字段，对象的各个 key 表示要返回或不要返回的字段，value 传入 true|false（或 1|-1）表示要返回还是不要返回。 -如果指定的字段是数组字段，还可以用以下方法只返回数组的第一个元素：在该字段 key 后面拼接上 `.$` 成为 `字段.$` 的形式。 -如果指定的字段是数组字段，还可以用 `db.command.project.slice` 方法返回数组的子数组： -方法既可以接收一个正数表示返回前 n 个元素，也可以接收一个负数表示返回后 n 个元素；还可以接收一个包含两个数字 `[ skip, limit ]` 的数组，如果 `skip` 是正数，表示跳过 `skip` 个元素后再返回接下来的 `limit` 个元素，如果 `skip` 是负数，表示从倒数第 `skip` 个元素开始，返回往后数的 `limit` 个元素 - -- 返回数组的前 5 个元素：`{ tags: db.command.project.slice(5) }` -- 返回数组的后 5 个元素：`{ tags: db.command.project.slice(-5) }` -- 跳过前 5 个元素，返回接下来 10 个元素：`{ tags: db.command.project.slice(5, 10) }` -- 从倒数第 5 个元素开始，返回接下来正方向数的 10 个元素：`{ tags: db.command.project.slice(-5, 10) }` - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.field.html) - -```tsx -(object: TaroGeneral.IAnyObject) => Query -``` - -| 参数 | 类型 | -| --- | --- | -| object | `TaroGeneral.IAnyObject` | - -##### 示例代码 - -返回 description, done 和 progress 三个字段： - -```tsx -db.collection('todos').field({ - description: true, - done: true, - progress: true, - // 只返回 tags 数组前 3 个元素 - tags: db.command.project.slice(3), -}) - .get() - .then(console.log) - .catch(console.error) -``` - -#### get - -获取集合数据，或获取根据查询条件筛选后的集合数据。 - -**使用说明** - -统计集合记录数或统计查询语句对应的结果记录数 - -小程序端与云函数端的表现会有如下差异： - -- 小程序端：如果没有指定 limit，则默认且最多取 20 条记录。 -- 云函数端：如果没有指定 limit，则默认且最多取 100 条记录。 - -如果没有指定 skip，则默认从第 0 条记录开始取，skip 常用于分页。 - -如果需要取集合中所有的数据，仅在数据量不大且在云函数中时 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.get.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).get().then(res => { - console.log(res.data) -}) -``` - -#### count - -统计匹配查询条件的记录的条数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/collection/Collection.count.html) - -```tsx -{ (options: OQ): void; (options: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| options | `OQ` | - -##### 示例代码 - -###### 示例 1 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).count().then(res => { - console.log(res.total) -}) -``` - -###### 示例 2 - -```tsx -const db = Taro.cloud.database() -db.collection('todos').where({ - _openid: 'xxx' // 填入当前用户 openid -}).count({ - success: function(res) { - console.log(res.total) - }, - fail: console.error -}) -``` - -#### IQueryCondition - -| 参数 | 类型 | -| --- | --- | -| __index | `__index` | - -#### IStringQueryCondition - -#### IQueryResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `IDocumentData[]` | 查询的结果数组，数据的每个元素是一个 Object，代表一条记录 | -| errMsg | `string` | 调用结果 | - -#### IQuerySingleResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `IDocumentData` | | -| errMsg | `string` | 调用结果 | - -#### IAddResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| _id | `DocumentId` | | -| errMsg | `string` | 调用结果 | - -#### IUpdateResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| stats | `{ updated: number; }` | | -| errMsg | `string` | 调用结果 | - -#### ISetResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| _id | `DocumentId` | | -| stats | `{ updated: number; created: number; }` | | -| errMsg | `string` | 调用结果 | - -#### IRemoveResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| stats | `{ removed: number; }` | | -| errMsg | `string` | 调用结果 | - -#### ICountResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| total | `number` | 结果数量 | -| errMsg | `string` | 调用结果 | - -### Command - -数据库操作符，通过 db.command 获取 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Command.html) - -#### eq - -查询筛选条件，表示字段等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.eq.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### neq - -查询筛选条件，表示字段不等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.neq.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### gt - -查询筛选操作符，表示需大于指定值。可以传入 Date 对象用于进行日期比较。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.gt.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### gte - -查询筛选操作符，表示需大于或等于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.gte.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### lt - -查询筛选操作符，表示需小于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.lt.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### lte - -查询筛选操作符，表示需小于或等于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.lte.html) - -```tsx -(val: any) => DatabaseQueryCommand -``` - -#### in - -查询筛选操作符，表示要求值在给定的数组内。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.in.html) - -```tsx -(val: any[]) => DatabaseQueryCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `any[]` | - -#### nin - -查询筛选操作符，表示要求值不在给定的数组内。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.nin.html) - -```tsx -(val: any[]) => DatabaseQueryCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `any[]` | - -#### geoNear - -按从近到远的顺序，找出字段值在给定点的附近的记录。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoNear.html) - -```tsx -(options: NearCommandOptions) => DatabaseQueryCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `NearCommandOptions` | - -#### geoWithin - -找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoWithin.html) - -```tsx -(options: WithinCommandOptions) => DatabaseQueryCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `WithinCommandOptions` | - -#### geoIntersects - -找出给定的地理位置图形相交的记录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoIntersects.html) - -```tsx -(options: IntersectsCommandOptions) => DatabaseQueryCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `IntersectsCommandOptions` | - -#### and - -查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.and.html) - -```tsx -(...expressions: (IQueryCondition | DatabaseLogicCommand)[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| expressions | (IQueryCondition or DatabaseLogicCommand)[] | - -#### or - -查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.or.html) - -```tsx -(...expressions: (IQueryCondition | DatabaseLogicCommand)[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| expressions | (IQueryCondition or DatabaseLogicCommand)[] | - -#### set - -查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.set.html) - -```tsx -(val: any) => DatabaseUpdateCommand -``` - -#### remove - -更新操作符，用于表示删除某个字段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.remove.html) - -```tsx -() => DatabaseUpdateCommand -``` - -#### inc - -更新操作符，原子操作，用于指示字段自增 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.inc.html) - -```tsx -(val: number) => DatabaseUpdateCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `number` | - -#### mul - -更新操作符，原子操作，用于指示字段自乘某个值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.mul.html) - -```tsx -(val: number) => DatabaseUpdateCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `number` | - -#### push - -数组更新操作符。对一个值为数组的字段，往数组添加一个或多个值。或字段原为空，则创建该字段并设数组为传入值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.push.html) - -```tsx -(...values: any[]) => DatabaseUpdateCommand -``` - -| 参数 | 类型 | -| --- | --- | -| values | `any[]` | - -#### pop - -数组更新操作符，对一个值为数组的字段，将数组尾部元素删除 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.pop.html) - -```tsx -() => DatabaseUpdateCommand -``` - -#### shift - -数组更新操作符，对一个值为数组的字段，将数组头部元素删除。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.shift.html) - -```tsx -() => DatabaseUpdateCommand -``` - -#### unshift - -数组更新操作符，对一个值为数组的字段，往数组头部添加一个或多个值。或字段原为空，则创建该字段并设数组为传入值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.unshift.html) - -```tsx -(...values: any[]) => DatabaseUpdateCommand -``` - -| 参数 | 类型 | -| --- | --- | -| values | `any[]` | - -#### DatabaseLogicCommand - -数据库逻辑操作符 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fieldName | string or InternalSymbol | 作用域名称 | -| operator | `string` | 操作符 | -| operands | `any[]` | 操作数 | -| _setFieldName | `(fieldName: string) => DatabaseLogicCommand` | 设置作用域名称 | - -##### and - -查询操作符，用于表示逻辑 "与" 的关系，表示需同时满足多个查询筛选条件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.and.html) - -```tsx -(...expressions: (IQueryCondition | DatabaseLogicCommand)[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| expressions | (IQueryCondition or DatabaseLogicCommand)[] | - -##### or - -查询操作符，用于表示逻辑 "或" 的关系，表示需同时满足多个查询筛选条件。或指令有两种用法，一是可以进行字段值的 “或” 操作，二是也可以进行跨字段的 “或” 操作。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.or.html) - -```tsx -(...expressions: (IQueryCondition | DatabaseLogicCommand)[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| expressions | (IQueryCondition or DatabaseLogicCommand)[] | - -#### DatabaseQueryCommand - -数据库查询操作符 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| operator | `string` | 操作符 | -| _setFieldName | `(fieldName: string) => DatabaseQueryCommand` | 设置作用域名称 | - -##### eq - -查询筛选条件，表示字段等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.eq.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### neq - -查询筛选条件，表示字段不等于某个值。eq 指令接受一个字面量 (literal)，可以是 number, boolean, string, object, array, Date。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.neq.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### gt - -查询筛选操作符，表示需大于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.gt.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### gte - -查询筛选操作符，表示需大于或等于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.gte.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### lt - -查询筛选操作符，表示需小于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.lt.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### lte - -查询筛选操作符，表示需小于或等于指定值。可以传入 Date 对象用于进行日期比较。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.lte.html) - -```tsx -(val: any) => DatabaseLogicCommand -``` - -##### in - -查询筛选操作符，表示要求值在给定的数组内。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.in.html) - -```tsx -(val: any[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `any[]` | - -##### nin - -查询筛选操作符，表示要求值不在给定的数组内。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.nin.html) - -```tsx -(val: any[]) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| val | `any[]` | - -##### geoNear - -按从近到远的顺序，找出字段值在给定点的附近的记录。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoNear.html) - -```tsx -(options: NearCommandOptions) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `NearCommandOptions` | - -##### geoWithin - -找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoWithin.html) - -```tsx -(options: WithinCommandOptions) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `WithinCommandOptions` | - -##### geoIntersects - -找出给定的地理位置图形相交的记录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/command/Command.geoIntersects.html) - -```tsx -(options: IntersectsCommandOptions) => DatabaseLogicCommand -``` - -| 参数 | 类型 | -| --- | --- | -| options | `IntersectsCommandOptions` | - -#### DatabaseUpdateCommand - -数据库更新操作符 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fieldName | string or InternalSymbol | 作用域名称 | -| operator | `keyof UPDATE_COMMANDS_LITERAL` | 操作符 | -| operands | `any[]` | 操作数 | -| _setFieldName | `(fieldName: string) => DatabaseUpdateCommand` | 设置作用域名称 | - -#### LOGIC_COMMANDS_LITERAL - -逻辑命令字面量 - -| 参数 | 说明 | -| --- | --- | -| and | 与 | -| or | 或 | -| not | 非 | -| nor | 都不 | - -#### QUERY_COMMANDS_LITERAL - -查询命令字面量 - -| 参数 | 说明 | -| --- | --- | -| eq | 等于 | -| neq | 不等于 | -| gt | 大于 | -| gte | 大于等于 | -| lt | 小于 | -| lte | 小于等于 | -| in | 范围内 | -| nin | 范围外 | -| geoNear | 附近排序 | -| geoWithin | 指定区域内 | -| geoIntersects | 相交区域 | - -#### UPDATE_COMMANDS_LITERAL - -更新命令字面量 - -| 参数 | 说明 | -| --- | --- | -| set | 等于 | -| remove | 删除 | -| inc | 自增 | -| mul | 自乘 | -| push | 尾部添加 | -| pop | 尾部删除 | -| shift | 头部删除 | -| unshift | 头部添加 | - -#### NearCommandOptions - -按从近到远的顺序，找出字段值在给定点的附近的记录参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| geometry | `GeoPoint` | 是 | 地理位置点 (Point) | -| maxDistance | `number` | 否 | 最大距离，单位为米 | -| minDistance | `number` | 否 | 最小距离，单位为米 | - -#### WithinCommandOptions - -找出字段值在指定区域内的记录，无排序参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| geometry | GeoPolygon or GeoMultiPolygon | 地理信息结构，Polygon，MultiPolygon，或 { centerSphere } | - -#### IntersectsCommandOptions - -找出给定的地理位置图形相交的记录 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| geometry | GeoPoint or GeoPolygon or GeoMultiPolygon or GeoMultiPoint or GeoLineString or GeoMultiLineString | 地理信息结构 | - -### Aggregate - -数据库集合的聚合操作实例 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.html) - -#### addFields - -聚合阶段。添加新字段到输出的记录。经过 addFields 聚合阶段，输出的所有记录中除了输入时带有的字段外，还将带有 addFields 指定的字段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.addFields.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### bucket - -聚合阶段。将输入记录根据给定的条件和边界划分成不同的组，每组即一个 bucket。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.bucket.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### bucketAuto - -聚合阶段。将输入记录根据给定的条件划分成不同的组，每组即一个 bucket。与 bucket 的其中一个不同之处在于无需指定 boundaries，bucketAuto 会自动尝试将记录尽可能平均的分散到每组中。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.bucketAuto.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### count - -聚合阶段。计算上一聚合阶段输入到本阶段的记录数，输出一个记录，其中指定字段的值为记录数。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.count.html) - -```tsx -(fieldName: string) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| fieldName | `string` | - -#### end - -标志聚合操作定义完成，发起实际聚合操作 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.end.html) - -```tsx -() => Promise -``` - -#### geoNear - -聚合阶段。将记录按照离给定点从近到远输出。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.geoNear.html) - -```tsx -(options: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| options | `Object` | - -#### group - -聚合阶段。将输入记录按给定表达式分组，输出时每个记录代表一个分组，每个记录的 _id 是区分不同组的 key。输出记录中也可以包括累计值，将输出字段设为累计值即会从该分组中计算累计值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.group.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### limit - -聚合阶段。限制输出到下一阶段的记录数。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.limit.html) - -```tsx -(value: number) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| value | `number` | - -#### lookup - -聚合阶段。聚合阶段。联表查询。与同个数据库下的一个指定的集合做 left outer join(左外连接)。对该阶段的每一个输入记录，lookup 会在该记录中增加一个数组字段，该数组是被联表中满足匹配条件的记录列表。lookup 会将连接后的结果输出给下个阶段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.lookup.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### match - -聚合阶段。根据条件过滤文档，并且把符合条件的文档传递给下一个流水线阶段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.match.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### project - -聚合阶段。把指定的字段传递给下一个流水线，指定的字段可以是某个已经存在的字段，也可以是计算出来的新字段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.project.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### replaceRoot - -聚合阶段。指定一个已有字段作为输出的根节点，也可以指定一个计算出的新字段作为根节点。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.replaceRoot.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### sample - -聚合阶段。随机从文档中选取指定数量的记录。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.sample.html) - -```tsx -(size: number) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| size | `number` | - -#### skip - -聚合阶段。指定一个正整数，跳过对应数量的文档，输出剩下的文档。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.skip.html) - -```tsx -(value: number) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| value | `number` | - -#### sort - -聚合阶段。根据指定的字段，对输入的文档进行排序。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.sort.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### sortByCount - -聚合阶段。根据传入的表达式，将传入的集合进行分组（group）。然后计算不同组的数量，并且将这些组按照它们的数量进行排序，返回排序后的结果。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.sortByCount.html) - -```tsx -(object: Object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Object` | - -#### unwind - -聚合阶段。使用指定的数组字段中的每个元素，对文档进行拆分。拆分后，文档会从一个变为一个或多个，分别对应数组的每个元素。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/aggregate/Aggregate.unwind.html) - -```tsx -(value: string | object) => Aggregate -``` - -| 参数 | 类型 | -| --- | --- | -| value | string or object | - -### IGeo - -数据库地理位置结构集 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/Geo.html) - -#### Point - -构造一个地理位置 ”点“。方法接受两个必填参数，第一个是经度（longitude），第二个是纬度（latitude），务必注意顺序。 - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.Point.html) - -```tsx -(longitude: number, latitide: number) => GeoPoint -``` - -| 参数 | 类型 | -| --- | --- | -| longitude | `number` | -| latitide | `number` | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: db.Geo.Point(113, 23) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -除了使用接口构造一个点外，也可以使用等价的 GeoJSON 的 点 (Point) 的 JSON 表示，其格式如下： - -```json -{ - "type": "Point", - "coordinates": [longitude, latitude] // 数字数组：[经度, 纬度] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'Point', - coordinates: [113, 23] - } - } -}).then(console.log).catch(console.error) -``` - -#### LineString - -构造一个地理位置的 ”线“。一个线由两个或更多的点有序连接组成。 - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.LineString.html) - -```tsx -(points: JSONMultiPoint | GeoPoint[]) => GeoMultiPoint -``` - -| 参数 | 类型 | -| --- | --- | -| points | JSONMultiPoint or GeoPoint[] | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: db.Geo.LineString([ - db.Geo.Point(113, 23), - db.Geo.Point(120, 50), - // ... 可选更多点 - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -除了使用接口构造一条 LineString 外，也可以使用等价的 GeoJSON 的 线 (LineString) 的 JSON 表示，其格式如下： - -```json -{ - "type": "LineString", - "coordinates": [ - [p1_lng, p1_lat], - [p2_lng, p2_lng] - // ... 可选更多点 - ] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'LineString', - coordinates: [ - [113, 23], - [120, 50] - ] - } - } -}).then(console.log).catch(console.error) -``` - -#### Polygon - -构造一个地理位置 ”多边形“ - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -**说明** - -一个多边形由一个或多个线性环（Linear Ring）组成，一个线性环即一个闭合的线段。一个闭合线段至少由四个点组成，其中最后一个点和第一个点的坐标必须相同，以此表示环的起点和终点。如果一个多边形由多个线性环组成，则第一个线性环表示外环（外边界），接下来的所有线性环表示内环（即外环中的洞，不计在此多边形中的区域）。如果一个多边形只有一个线性环组成，则这个环就是外环。 - -多边形构造规则： - -1. 第一个线性环必须是外环 -2. 外环不能自交 -3. 所有内环必须完全在外环内 -4. 各个内环间不能相交或重叠，也不能有共同的边 -5. 外环应为逆时针，内环应为顺时针 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.Polygon.html) - -```tsx -(lineStrings: JSONPolygon | GeoLineString[]) => GeoPolygon -``` - -| 参数 | 类型 | -| --- | --- | -| lineStrings | JSONPolygon or GeoLineString[] | - -##### 示例代码 - -###### 示例 1 - -单环多边形 - -```tsx -const { Polygon, LineString, Point } = db.Geo -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: Polygon([ - LineString([ - Point(0, 0), - Point(3, 2), - Point(2, 3), - Point(0, 0) - ]) - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -含一个外环和一个内环的多边形 - -```tsx -const { Polygon, LineString, Point } = db.Geo -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: Polygon([ - // 外环 - LineString([ Point(0, 0), Point(30, 20), Point(20, 30), Point(0, 0) ]), - // 内环 - LineString([ Point(10, 10), Point(16, 14), Point(14, 16), Point(10, 10) ]) - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 3 - -除了使用接口构造一个 Polygon 外，也可以使用等价的 GeoJSON 的 多边形 (Polygon) 的 JSON 表示，其格式如下： - -```json -{ - "type": "Polygon", - "coordinates": [ - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], // 外环 - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], // 可选内环 1 - ... - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], // 可选内环 n - ] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'Polygon', - coordinates: [ - [ [0, 0], [30, 20], [20, 30], [0, 0] ], - [ [10, 10], [16, 14], [14, 16], [10, 10]] - ] - } - } -}).then(console.log).catch(console.error) -``` - -#### MultiPoint - -构造一个地理位置的 ”点“ 的集合。一个点集合由一个或更多的点组成。 - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.MultiPoint.html) - -```tsx -(polygons: JSONMultiPolygon | GeoPolygon[]) => GeoMultiPolygon -``` - -| 参数 | 类型 | -| --- | --- | -| polygons | JSONMultiPolygon or GeoPolygon[] | - -##### 示例代码 - -###### 示例 1 - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: db.Geo.MultiPoint([ - db.Geo.Point(113, 23), - db.Geo.Point(120, 50), - // ... 可选更多点 - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -除了使用接口构造 MultiPoint 外，也可以使用等价的 GeoJSON 的 点集合 (MultiPoint) 的 JSON 表示，其格式如下： - -```json -{ - "type": "MultiPoint", - "coordinates": [ - [p1_lng, p1_lat], - [p2_lng, p2_lng] - // ... 可选更多点 - ] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'MultiPoint', - coordinates: [ - [113, 23], - [120, 50] - ] - } - } -}).then(console.log).catch(console.error) -``` - -#### MultiLineString - -构造一个地理位置 ”线“ 集合。一个线集合由多条线组成。 - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.MultiLineString.html) - -```tsx -(lineStrings: JSONMultiLineString | GeoLineString[]) => GeoMultiLineString -``` - -| 参数 | 类型 | -| --- | --- | -| lineStrings | JSONMultiLineString or GeoLineString[] | - -##### 示例代码 - -###### 示例 1 - -```tsx -const { LineString, MultiLineString, Point } = db.Geo -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: MultiLineString([ - LineString([ Point(0, 0), Point(30, 20), Point(20, 30), Point(0, 0) ]), - LineString([ Point(10, 10), Point(16, 14), Point(14, 16), Point(10, 10) ]) - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -除了使用接口构造一个 MultiLineString 外，也可以使用等价的 GeoJSON 的 线集合 (MultiLineString) 的 JSON 表示，其格式如下： - -```json -{ - "type": "MultiLineString", - "coordinates": [ - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - ... - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ] - ] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'MultiLineString', - coordinates: [ - [ [0, 0], [3, 3] ], - [ [5, 10], [20, 30] ] - ] - } - } -}).then(console.log).catch(console.error) -``` - -#### MultiPolygon - -构造一个地理位置 ”多边形“ 集合。一个多边形集合由多个多边形组成。 - -如存储地理位置信息的字段有被查询的需求，务必对字段建立地理位置索引 - -**说明** - -一个多边形由一个或多个线性环（Linear Ring）组成，一个线性环即一个闭合的线段。一个闭合线段至少由四个点组成，其中最后一个点和第一个点的坐标必须相同，以此表示环的起点和终点。如果一个多边形由多个线性环组成，则第一个线性环表示外环（外边界），接下来的所有线性环表示内环（即外环中的洞，不计在此多边形中的区域）。如果一个多边形只有一个线性环组成，则这个环就是外环。 - -多边形构造规则： - -1. 第一个线性环必须是外环 -2. 外环不能自交 -3. 所有内环必须完全在外环内 -4. 各个内环间不能相交或重叠，也不能有共同的边 -5. 外环应为逆时针，内环应为顺时针 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/Geo.MultiPolygon.html) - -```tsx -(polygons: JSONMultiPolygon | GeoPolygon[]) => GeoMultiPolygon -``` - -| 参数 | 类型 | -| --- | --- | -| polygons | JSONMultiPolygon or GeoPolygon[] | - -##### 示例代码 - -###### 示例 1 - -```tsx -const { MultiPolygon, Polygon, LineString, Point } = db.Geo -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: MultiPolygon([ - Polygon([ - LineString([ Point(50, 50), Point(60, 80), Point(80, 60), Point(50, 50) ]), - ]), - Polygon([ - LineString([ Point(0, 0), Point(30, 20), Point(20, 30), Point(0, 0) ]), - LineString([ Point(10, 10), Point(16, 14), Point(14, 16), Point(10, 10) ]) - ]), - ]) - } -}).then(console.log).catch(console.error) -``` - -###### 示例 2 - -除了使用接口构造一个 MultiPolygon 外，也可以使用等价的 GeoJSON 的 多边形 (MultiPolygon) 的 JSON 表示，其格式如下： - -```json -{ - "type": "MultiPolygon", - "coordinates": [ - // polygon 1 - [ - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - ... - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ] - ], - ... - // polygon n - [ - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ], - ... - [ [lng, lat], [lng, lat], [lng, lat], ..., [lng, lat] ] - ], - ] -} -``` - -```tsx -db.collection('todos').add({ - data: { - description: 'eat an apple', - location: { - type: 'MultiPolygon', - coordinates: [ - [ - [ [50, 50], [60, 80], [80, 60], [50, 50] ] - ], - [ - [ [0, 0], [30, 20], [20, 30], [0, 0] ], - [ [10, 10], [16, 14], [14, 16], [10, 10]] - ] - ] - } - } -}).then(console.log).catch(console.error) -``` - -#### GeoPoint - -地理位置 “点” - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoPoint.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| longitude | `number` | 经度 | -| latitude | `number` | 纬度 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => object -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### GeoLineString - -地理位置的 ”线“。一个线由两个或更多的点有序连接组成。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoLineString.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| points | `GeoPoint[]` | 点集合 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => JSONLineString -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### GeoPolygon - -地理位置 ”多边形“ - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoPolygon.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lines | `GeoLineString[]` | 线集合 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => JSONPolygon -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### GeoMultiPoint - -地理位置的 ”点“ 的集合。一个点集合由一个或更多的点组成。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoMultiPoint.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| points | `GeoPoint[]` | 点集合 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => JSONMultiPoint -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### GeoMultiLineString - -地理位置 ”线“ 集合。一个线集合由多条线组成。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoMultiLineString.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lines | `GeoLineString[]` | 线集合 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => JSONMultiLineString -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### GeoMultiPolygon - -地理位置 ”多边形“ 集合。一个多边形集合由多个多边形组成。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/database/geo/GeoMultiPolygon.html) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| polygons | `GeoPolygon[]` | 多边形集合 | - -##### toJSON - -格式化为 JSON 结构 - -```tsx -() => JSONMultiPolygon -``` - -##### toString - -格式化为字符串 - -```tsx -() => string -``` - -#### JSONPoint - -地理位置 “点” 的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"Point"` | 类型 | -| coordinates | `[number, number]` | 坐标 | - -#### JSONLineString - -地理位置 ”线“ 的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"LineString"` | 类型 | -| coordinates | `[number, number][]` | 坐标 | - -#### JSONPolygon - -地理位置 ”多边形“ 的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"Polygon"` | 类型 | -| coordinates | `[number, number][][]` | 坐标 | - -#### JSONMultiPoint - -地理位置的 ”点“ 集合的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"MultiPoint"` | 类型 | -| coordinates | `[number, number][]` | 坐标 | - -#### JSONMultiLineString - -地理位置 ”线“ 集合的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"MultiLineString"` | 类型 | -| coordinates | `[number, number][][]` | 坐标 | - -#### JSONMultiPolygon - -地理位置 ”多边形“ 集合的 JSON 结构 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `"MultiPolygon"` | 类型 | -| coordinates | `[number, number][][][]` | 坐标 | diff --git a/versioned_docs/version-4.x/apis/cloud/cloud.md b/versioned_docs/version-4.x/apis/cloud/cloud.md deleted file mode 100644 index e68999838538..000000000000 --- a/versioned_docs/version-4.x/apis/cloud/cloud.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -title: cloud -sidebar_label: cloud ---- - -云开发 SDK 实例 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/Cloud.html) - -## 类型 - -```tsx -cloud & Cloud -``` - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| Cloud | `new (options: IOptions) => Cloud` | 声明新的云开发操作实例
API 支持度: weapp
example: 声明新的操作实例

```tsx
const c1 = new Taro.cloud.Cloud({
resourceEnv: '我的某个环境ID',
})
```
example: 资源共享时跨账号访问资源

```tsx
// 声明
const c1 = new Taro.cloud.Cloud({
resourceAppid: '资源方 AppID',
resourceEnv: '我的某个环境ID',
})
// 等待初始化完成
await c1.init()

// 然后照常访问指定环境下的资源
c1.callFunction({
name: '',
data: {},
})
```
[参考地址](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/utils/Cloud.Cloud.html) | - -### init - -在调用云开发各 API 前，需先调用初始化方法 init 一次（全局只需一次，多次调用时只有第一次生效） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/init/client.init.html) - -```tsx -(config?: IInitConfig) => void -``` - -| 参数 | 类型 | -| --- | --- | -| config | `IInitConfig` | - -#### 示例代码 - -```tsx -Taro.cloud.init({ - env: 'test-x1dzi' -}) -``` - -### CloudID - -声明字符串为 CloudID（开放数据 ID），该接口传入一个字符串，返回一个 CloudID 特殊对象，将该对象传至云函数可以获取其对应的开放数据。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/open/Cloud.CloudID.html) - -```tsx -(cloudID: string) => void -``` - -| 参数 | 类型 | -| --- | --- | -| cloudID | `string` | - -### callFunction - -调用云函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/functions/Cloud.callFunction.html) - -```tsx -{ (param: OQ): void; (param: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| param | `OQ` | - -#### 示例代码 - -假设已有一个云函数 add，在小程序端发起对云函数 add 的调用： - -```tsx -Taro.cloud.callFunction({ -// 要调用的云函数名称 -name: 'add', - // 传递给云函数的event参数 - data: { - x: 1, - y: 2, - } -}).then(res => { - // output: res.result === 3 -}).catch(err => { - // handle error -}) -``` - -### uploadFile - -将本地资源上传至云存储空间，如果上传至同一路径则是覆盖写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/storage/uploadFile/client.uploadFile.html) - -```tsx -{ (param: OQ): Taro.UploadTask; (param: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| param | `OQ` | - -#### 示例代码 - -##### 示例 1 - -```tsx -Taro.cloud.uploadFile({ - cloudPath: 'example.png', - filePath: '', // 文件路径 - success: res => { - // get resource ID - console.log(res.fileID) - }, - fail: err => { - // handle error - } -}) -``` - -##### 示例 2 - -```tsx -Taro.cloud.uploadFile({ - cloudPath: 'example.png', - filePath: '', // 文件路径 -}).then(res => { - // get resource ID - console.log(res.fileID) -}).catch(error => { - // handle error -}) -``` - -### downloadFile - -从云存储空间下载文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/storage/downloadFile/client.downloadFile.html) - -```tsx -{ (param: OQ): DownloadTask; (param: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| param | `OQ` | - -#### 示例代码 - -##### 示例 1 - -```tsx -Taro.cloud.downloadFile({ - fileID: 'a7xzcb', - success: res => { - // get temp file path - console.log(res.tempFilePath) - }, - fail: err => { - // handle error - } -}) -``` - -##### 示例 2 - -```tsx -Taro.cloud.downloadFile({ - fileID: 'a7xzcb' -}).then(res => { - // get temp file path - console.log(res.tempFilePath) -}).catch(error => { - // handle error -}) -``` - -### getTempFileURL - -用云文件 ID 换取真实链接，公有读的文件获取的链接不会过期，私有的文件获取的链接十分钟有效期。一次最多取 50 个。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/storage/Cloud.getTempFileURL.html) - -```tsx -{ (param: OQ): void; (param: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| param | `OQ` | - -#### 示例代码 - -##### 示例 1 - -```tsx -Taro.cloud.getTempFileURL({ - fileList: [{ - fileID: 'a7xzcb', - maxAge: 60 * 60, // one hour - }] -}).then(res => { - // get temp file URL - console.log(res.fileList) -}).catch(error => { - // handle error -}) -``` - -##### 示例 2 - -```tsx -Taro.cloud.getTempFileURL({ - fileList: ['cloud://xxx', 'cloud://yyy'], - success: res => { - // get temp file URL - console.log(res.fileList) - }, - fail: err => { - // handle error - } -}) -``` - -### deleteFile - -从云存储空间删除文件，一次最多 50 个 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/storage/Cloud.deleteFile.html) - -```tsx -{ (param: OQ): void; (param: RQ): Promise; } -``` - -| 参数 | 类型 | -| --- | --- | -| param | `OQ` | - -#### 示例代码 - -##### 示例 1 - -```tsx -.cloud.deleteFile({ - fileList: ['a7xzcb'] -}).then(res => { - // handle success - console.log(res.fileList) -}).catch(error => { - // handle error -}) -``` - -##### 示例 2 - -```tsx -Taro.cloud.deleteFile({ - fileList: ['a7xzcb'], - success: res => { - // handle success - console.log(res.fileList) - }, - fail: err => { - // handle error - }, - complete: res => { - // ... - } -}) -``` - -### database - -获取数据库实例 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/Cloud.database.html) - -```tsx -(config?: IConfig) => Database -``` - -| 参数 | 类型 | -| --- | --- | -| config | `IConfig` | - -#### 示例代码 - -##### 示例 1 - -以下调用获取默认环境的数据库的引用： - -```tsx -const db = Taro.cloud.database() -``` - -##### 示例 2 - -假设有一个环境名为 test-123，用做测试环境，那么可以如下获取测试环境数据库： - -```tsx -const testDB = Taro.cloud.database({ - env: 'test-123' -}) -``` - -### callContainer - -调用云托管服务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/container/Cloud.callContainer.html) - -```tsx -(params: CallContainerParam

) => Promise> -``` - -| 参数 | 类型 | -| --- | --- | -| params | `R` | - -#### 示例代码 - -假设已经初始化了一个叫c1的云开发实例，并发起云托管调用 - -``` tsx -const r = await c1.callContainer({ - path: '/path/to/container', // 填入容器的访问路径 - method: 'POST', -}) -``` - -## 参数 - -### CallFunctionResult - -云函数通用返回 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| result | `any` | 云函数返回的结果 | -| errMsg | `string` | 调用结果 | - -### IApiParam - -云函数通用参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | -| success | `(res: T) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(err: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(val: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### IInitConfig - -初始化配置 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| env | string or { database?: string; functions?: string; storage?: string; } | 否 | 默认环境配置，传入字符串形式的环境 ID 可以指定所有服务的默认环境，传入对象可以分别指定各个服务的默认环境 | -| traceUser | `boolean` | 否 | 是否在将用户访问记录到用户管理中，在控制台中可见 | - -### IConfig - -配置 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| env | `string` | 否 | 使用的环境 ID，填写后忽略 init 指定的环境 | -| traceUser | `boolean` | 否 | 是否在将用户访问记录到用户管理中，在控制台中可见 | - -### ICloudAPIParam - -云函数 API 通用参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| config | `IConfig` | 否 | 配置 | - -### CallFunctionParam - -调用云函数参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| name | `string` | 是 | 云函数名 | -| data | `TaroGeneral.IAnyObject` | 否 | 传递给云函数的参数，在云函数中可通过 event 参数获取 | -| slow | `boolean` | 否 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: CallFunctionResult) => void` | 否 | 接口调用成功的回调函数 | - -### UploadFileResult - -上传文件结果 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileID | `string` | 文件 ID | -| statusCode | `number` | 服务器返回的 HTTP 状态码 | -| errMsg | `string` | 调用结果 | - -### UploadFileParam - -上传文件参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cloudPath | `string` | 是 | 云存储路径，命名限制见[文件名命名限制](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-sdk-api/guide/storage/naming.html) | -| filePath | `string` | 是 | 要上传文件资源的路径 | -| header | `TaroGeneral.IAnyObject` | 否 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: UploadFileResult) => void` | 否 | 接口调用成功的回调函数 | - -### DownloadFileResult - -下载文件结果 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 临时文件路径 | -| statusCode | `number` | 服务器返回的 HTTP 状态码 | -| errMsg | `string` | 调用结果 | - -### DownloadFileParam - -下载文件参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fileID | `string` | 是 | 云文件 ID | -| cloudPath | `string` | 否 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: DownloadFileResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetTempFileURLResult - -获取临时文件结果 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileList | `GetTempFileURLResultItem[]` | 文件列表 | -| errMsg | `string` | 调用结果 | - -### GetTempFileURLResultItem - -临时文件列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileID | `string` | 云文件 ID | -| tempFileURL | `string` | 临时文件路径 | -| maxAge | `number` | | -| status | `number` | 状态码 | -| errMsg | `string` | 调用结果 | - -### GetTempFileURLParam - -获取临时文件参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fileList | `string[]` | 是 | | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: GetTempFileURLResult) => void` | 否 | 接口调用成功的回调函数 | - -### DeleteFileResult - -删除文件结果 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileList | `DeleteFileResultItem[]` | 文件列表 | -| errMsg | `string` | 调用结果 | - -### DeleteFileResultItem - -删除文件列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileID | `string` | 云文件 ID | -| status | `number` | 状态码 | -| errMsg | `string` | 调用结果 | - -### DeleteFileParam - -删除文件参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fileList | `string[]` | 是 | 文件列表 | -| config | `IConfig` | 否 | 配置 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: DeleteFileResult) => void` | 否 | 接口调用成功的回调函数 | - -### IOptions - -新建云开发操作实例 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| resourceAppid | `string` | 否 | 资源方 AppID, 不填则表示已登录的当前账号（如小程序中） | -| resourceEnv | `string` | 是 | 资源方云环境 ID | - -### CallContainerParam - -调用云托管参数 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 服务路径 | -| method | string or number or symbol | 否 | HTTP请求方法，默认 GET | -| data | `P` | 否 | 请求数据 | -| header | `TaroGeneral.IAnyObject` | 否 | 设置请求的 header，header 中不能设置 Referer。content-type 默认为 application/json | -| timeout | `number` | 否 | 超时时间，单位为毫秒 | -| dataType | `request.DataType` | 否 | 返回的数据格式 | -| responseType | "text" or "arraybuffer" | 否 | 响应的数据类型 | -| complete | `(res: any) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: CallFunctionResult) => void` | 否 | 接口调用成功的回调函数 | - -### CallContainerResult - -调用云托管返回值 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `R` | 是 | 开发者云托管服务返回的数据 | -| header | `TaroGeneral.IAnyObject` | 是 | 开发者云托管返回的 HTTP Response Header | -| statusCode | `number` | 是 | 开发者云托管服务返回的 HTTP 状态码 | -| cookies | `TaroGeneral.IAnyObject` | 否 | 开发者云托管返回的 cookies，格式为字符串数组，仅小程序端有此字段 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| cloud.init | ✔️ | | | | -| cloud.callFunction | ✔️ | | | | -| cloud.uploadFile | ✔️ | | | | -| cloud.downloadFile | ✔️ | | | | -| cloud.getTempFileURL | ✔️ | | | | -| cloud.deleteFile | ✔️ | | | | -| cloud.database | ✔️ | | | | -| cloud.Cloud | ✔️ | | | | -| cloud.callContainer | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/data-analysis/getCommonConfig.md b/versioned_docs/version-4.x/apis/data-analysis/getCommonConfig.md deleted file mode 100644 index ccaca1977951..000000000000 --- a/versioned_docs/version-4.x/apis/data-analysis/getCommonConfig.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Taro.getCommonConfig(option) -sidebar_label: getCommonConfig ---- - -给定实验参数数组，获取对应的实验参数值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.getCommonConfig.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| keys | `string[]` | 否 | 需要获取的数据指标的对象数组，每个string的格式约定：配置类型_分表key | -| mode | 0 or 1 | 是 | 0：通用配置模式 1：实验模式, 参数与返回结果的使用等效于接口wx.getExptInfoSync | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errcode | `number` | 错误码 | -| errmsg | `string` | 错误信息 | -| conf_type | `number` | 配置类型, 1-表类型 2-kv类型 | -| conf | `string` | 根据conf_type来确定conf内容, conf_type为1时conf是一个json数组, 类似"[{xxx},{xxx}]", 每一项对应表类型每一行配置内容, 其中conf_type为2时conf是一个json对象，类似"{xxxx}" | -| expire_sec | `number` | 过期时间,单位秒. 0表示当次有效 | - -## 示例代码 - -```tsx -Taro.getCommonConfig({ - keys:["key1", "key2"], - mode: 0, - success: (res) => { - console.log("success") - console.log(res) - }, - fail: (res) => { - console.log("fail") - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/data-analysis/getExptInfoSync.md b/versioned_docs/version-4.x/apis/data-analysis/getExptInfoSync.md deleted file mode 100644 index cb8c2a1e5c19..000000000000 --- a/versioned_docs/version-4.x/apis/data-analysis/getExptInfoSync.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Taro.getExptInfoSync(keys) -sidebar_label: getExptInfoSync ---- - -给定实验参数数组，获取对应的实验参数值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.getExptInfoSync.html) - -## 类型 - -```tsx -(keys?: string[]) => TaroGeneral.IAnyObject -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| keys | `string[]` | 实验参数数组，不填则获取所有实验参数 | - -## 示例代码 - -```tsx -Taro.getExptInfoSync(['color']) -``` diff --git a/versioned_docs/version-4.x/apis/data-analysis/reportAnalytics.md b/versioned_docs/version-4.x/apis/data-analysis/reportAnalytics.md deleted file mode 100644 index c73848865c72..000000000000 --- a/versioned_docs/version-4.x/apis/data-analysis/reportAnalytics.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.reportAnalytics(eventName, data) -sidebar_label: reportAnalytics ---- - -自定义分析数据上报接口。使用前，需要在小程序管理后台自定义分析中新建事件，配置好事件名与字段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportAnalytics.html) - -## 类型 - -```tsx -(eventName: string, data: TaroGeneral.IAnyObject) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名 | -| data | `TaroGeneral.IAnyObject` | 上报的自定义数据，key 为配置中的字段名，value 为上报的数据。 | - -## 示例代码 - -```tsx -Taro.reportAnalytics('purchase', { - price: 120, - color: 'red' -}) -``` diff --git a/versioned_docs/version-4.x/apis/data-analysis/reportEvent.md b/versioned_docs/version-4.x/apis/data-analysis/reportEvent.md deleted file mode 100644 index e3b61a4079a4..000000000000 --- a/versioned_docs/version-4.x/apis/data-analysis/reportEvent.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.reportEvent(eventId, data) -sidebar_label: reportEvent ---- - -事件上报 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportEvent.html) - -## 类型 - -```tsx -(eventId: string, data: TaroGeneral.IAnyObject) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventId | `string` | 事件名 | -| data | `TaroGeneral.IAnyObject` | 上报的自定义数据，key 为配置中的字段名，value 为上报的数据。 | - -## 示例代码 - -```tsx -Taro.reportEvent('purchase', { - price: 120, - color: 'red' -}) -``` diff --git a/versioned_docs/version-4.x/apis/data-analysis/reportMonitor.md b/versioned_docs/version-4.x/apis/data-analysis/reportMonitor.md deleted file mode 100644 index 7787e3c6e18a..000000000000 --- a/versioned_docs/version-4.x/apis/data-analysis/reportMonitor.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.reportMonitor(name, value) -sidebar_label: reportMonitor ---- - -自定义业务数据监控上报接口。 - -**使用说明** -使用前，需要在「小程序管理后台-运维中心-性能监控-业务数据监控」中新建监控事件，配置监控描述与告警类型。每一个监控事件对应唯一的监控ID，开发者最多可以创建128个监控事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportMonitor.html) - -## 类型 - -```tsx -(name: string, value: number) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| name | `string` | 监控ID，在「小程序管理后台」新建数据指标后获得 | -| value | `number` | 上报数值，经处理后会在「小程序管理后台」上展示每分钟的上报总量 | - -## 示例代码 - -```tsx -Taro.reportMonitor('1', 1) -``` diff --git a/versioned_docs/version-4.x/apis/device/accelerometer/offAccelerometerChange.md b/versioned_docs/version-4.x/apis/device/accelerometer/offAccelerometerChange.md deleted file mode 100644 index 4dadacc7dc52..000000000000 --- a/versioned_docs/version-4.x/apis/device/accelerometer/offAccelerometerChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offAccelerometerChange(callback) -sidebar_label: offAccelerometerChange ---- - -取消监听加速度数据事件，参数为空，则取消所有的事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.offAccelerometerChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 加速度数据事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/accelerometer/onAccelerometerChange.md b/versioned_docs/version-4.x/apis/device/accelerometer/onAccelerometerChange.md deleted file mode 100644 index f2f4da2692eb..000000000000 --- a/versioned_docs/version-4.x/apis/device/accelerometer/onAccelerometerChange.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.onAccelerometerChange(callback) -sidebar_label: onAccelerometerChange ---- - -监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 `Taro.stopAccelerometer` 停止监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.onAccelerometerChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Callback - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | X 轴 | -| y | `number` | Y 轴 | -| z | `number` | Z 轴 | - -## 示例代码 - -```tsx -Taro.onAccelerometerChange(res => { - console.log(res.x) - console.log(res.y) - console.log(res.z) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/accelerometer/startAccelerometer.md b/versioned_docs/version-4.x/apis/device/accelerometer/startAccelerometer.md deleted file mode 100644 index 68e062742ba6..000000000000 --- a/versioned_docs/version-4.x/apis/device/accelerometer/startAccelerometer.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.startAccelerometer(res) -sidebar_label: startAccelerometer ---- - -开始监听加速度数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.startAccelerometer.html) - -## 类型 - -```tsx -(res?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| interval | `keyof Interval` | `"normal"` | 否 | 监听加速度数据回调函数的执行频率 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### Interval - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| game | `"game"` | 适用于更新游戏的回调频率，在 20ms/次 左右 | -| ui | `"ui"` | 适用于更新 UI 的回调频率，在 60ms/次 左右 | -| normal | `"normal"` | 普通的回调频率，在 200ms/次 左右 | - -## 示例代码 - -```tsx -Taro.startAccelerometer({ interval: 'game' }) -``` diff --git a/versioned_docs/version-4.x/apis/device/accelerometer/stopAccelerometer.md b/versioned_docs/version-4.x/apis/device/accelerometer/stopAccelerometer.md deleted file mode 100644 index 0e3fa7b7e939..000000000000 --- a/versioned_docs/version-4.x/apis/device/accelerometer/stopAccelerometer.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.stopAccelerometer(res) -sidebar_label: stopAccelerometer ---- - -停止监听加速度数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.stopAccelerometer.html) - -## 类型 - -```tsx -(res?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopAccelerometer() -``` diff --git a/versioned_docs/version-4.x/apis/device/accessibility/checkIsOpenAccessibility.md b/versioned_docs/version-4.x/apis/device/accessibility/checkIsOpenAccessibility.md deleted file mode 100644 index a65a07837a21..000000000000 --- a/versioned_docs/version-4.x/apis/device/accessibility/checkIsOpenAccessibility.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.checkIsOpenAccessibility(option) -sidebar_label: checkIsOpenAccessibility ---- - -检测是否开启视觉无障碍功能。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/accessibility/wx.checkIsOpenAccessibility.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| open | `boolean` | iOS 上开启辅助功能旁白，安卓开启 talkback 时返回 true | diff --git a/versioned_docs/version-4.x/apis/device/battery/getBatteryInfo.md b/versioned_docs/version-4.x/apis/device/battery/getBatteryInfo.md deleted file mode 100644 index f285d96ed474..000000000000 --- a/versioned_docs/version-4.x/apis/device/battery/getBatteryInfo.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.getBatteryInfo(option) -sidebar_label: getBatteryInfo ---- - -获取设备电量。同步 API Taro.getBatteryInfoSync 在 iOS 上不可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/battery/wx.getBatteryInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isCharging | `boolean` | 是否正在充电中 | -| level | `number` | 设备电量，范围 1 - 100 | -| errMsg | `string` | 调用结果 | diff --git a/versioned_docs/version-4.x/apis/device/battery/getBatteryInfoSync.md b/versioned_docs/version-4.x/apis/device/battery/getBatteryInfoSync.md deleted file mode 100644 index 82f54498f9d5..000000000000 --- a/versioned_docs/version-4.x/apis/device/battery/getBatteryInfoSync.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Taro.getBatteryInfoSync() -sidebar_label: getBatteryInfoSync ---- - -Taro.getBatteryInfo 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/battery/wx.getBatteryInfoSync.html) - -## 类型 - -```tsx -() => Result -``` - -## 参数 - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isCharging | `boolean` | 是否正在充电中 | -| level | `number` | 设备电量，范围 1 - 100 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/closeBLEConnection.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/closeBLEConnection.md deleted file mode 100644 index 0aef19a87148..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/closeBLEConnection.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.closeBLEConnection(option) -sidebar_label: closeBLEConnection ---- - -断开与低功耗蓝牙设备的连接。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.closeBLEConnection.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 用于区分设备的 id | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.closeBLEConnection({ - deviceId, - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/createBLEConnection.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/createBLEConnection.md deleted file mode 100644 index fd8144e619de..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/createBLEConnection.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.createBLEConnection(option) -sidebar_label: createBLEConnection ---- - -连接低功耗蓝牙设备。 - -若小程序在之前已有搜索过某个蓝牙设备，并成功建立连接，可直接传入之前搜索获取的 deviceId 直接尝试连接该设备，无需进行搜索操作。 - -**注意** -- 请保证尽量成对的调用 `createBLEConnection` 和 `closeBLEConnection` 接口。安卓如果多次调用 `createBLEConnection` 创建连接，有可能导致系统持有同一设备多个连接的实例，导致调用 `closeBLEConnection` 的时候并不能真正的断开与设备的连接。 -- 蓝牙连接随时可能断开，建议监听 Taro.onBLEConnectionStateChange 回调事件，当蓝牙设备断开时按需执行重连操作 -- 若对未连接的设备或已断开连接的设备调用数据读写操作的接口，会返回 10006 错误，建议进行重连操作。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 用于区分设备的 id | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | -| timeout | `number` | 否 | 超时时间，单位ms，不填表示不会超时 | - -## 示例代码 - -```tsx -Taro.createBLEConnection({ - // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 - deviceId, - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceCharacteristics.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceCharacteristics.md deleted file mode 100644 index 27c5a16b31a3..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceCharacteristics.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Taro.getBLEDeviceCharacteristics(option) -sidebar_label: getBLEDeviceCharacteristics ---- - -获取蓝牙设备某个服务中所有特征值(characteristic)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceCharacteristics.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 蓝牙设备 id | -| serviceId | `string` | 是 | 蓝牙服务 uuid，需要使用 `getBLEDeviceServices` 获取 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| characteristics | `BLECharacteristic[]` | 设备特征值列表 | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### BLECharacteristic - -设备特征值列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| properties | `Properties` | 该特征值支持的操作类型 | -| uuid | `string` | 蓝牙设备特征值的 uuid | - -### Properties - -该特征值支持的操作类型 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| indicate | `boolean` | 该特征值是否支持 indicate 操作 | -| notify | `boolean` | 该特征值是否支持 notify 操作 | -| read | `boolean` | 该特征值是否支持 read 操作 | -| write | `boolean` | 该特征值是否支持 write 操作 | -| writeNoResponse | `boolean` | 该特征是否支持无回复写操作 | -| writeDefault | `boolean` | 该特征是否支持有回复写操作 | - -## 示例代码 - -```tsx -Taro.getBLEDeviceCharacteristics({ - // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 - deviceId, - // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取 - serviceId, - success: function (res) { - console.log('device getBLEDeviceCharacteristics:', res.characteristics) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceRSSI.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceRSSI.md deleted file mode 100644 index 27817493e820..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceRSSI.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.getBLEDeviceRSSI(option) -sidebar_label: getBLEDeviceRSSI ---- - -获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceRSSI.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 蓝牙设备 id | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| RSSI | `number` | 信号强度，单位 dBm | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceServices.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceServices.md deleted file mode 100644 index edaeea821220..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEDeviceServices.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Taro.getBLEDeviceServices(option) -sidebar_label: getBLEDeviceServices ---- - -获取蓝牙设备所有服务(service)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 蓝牙设备 id | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| services | `BLEService[]` | 设备服务列表 | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### BLEService - -设备服务列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isPrimary | `boolean` | 该服务是否为主服务 | -| uuid | `string` | 蓝牙设备服务的 uuid | - -## 示例代码 - -```tsx -Taro.getBLEDeviceServices({ - // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 - deviceId, - success: function (res) { - console.log('device services:', res.services) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEMTU.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEMTU.md deleted file mode 100644 index e3d8471008b6..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/getBLEMTU.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Taro.getBLEMTU(option) -sidebar_label: getBLEMTU ---- - -获取蓝牙低功耗的最大传输单元。需在 [Taro.createBLEConnection](/docs/apis/device/bluetooth-ble/createBLEConnection) 调用成功后调用。 - -注意: -- 小程序中 MTU 为 ATT_MTU，包含 Op-Code 和 Attribute Handle 的长度，实际可以传输的数据长度为 ATT_MTU - 3 -- iOS 系统中 MTU 为固定值；安卓系统中，MTU 会在系统协商成功之后发生改变，建议使用 [Taro.onBLEMTUChange](/docs/apis/device/bluetooth-ble/onBLEMTUChange) 监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEMTU.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| deviceId | `string` | | 是 | 蓝牙设备 id | -| writeType | `keyof WriteType` | `"write"` | 否 | 写模式 （iOS 特有参数） | -| complete | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mtu | `number` | 最大传输单元 | - -### WriteType - -写模式合法值 - -| 参数 | 说明 | -| --- | --- | -| write | 有回复写 | -| writeNoResponse | 无回复写 | - -## 示例代码 - -```tsx -Taro.getBLEMTU({ - deviceId: '', - writeType: 'write', - success (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/notifyBLECharacteristicValueChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/notifyBLECharacteristicValueChange.md deleted file mode 100644 index ac2f59534828..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/notifyBLECharacteristicValueChange.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Taro.notifyBLECharacteristicValueChange(option) -sidebar_label: notifyBLECharacteristicValueChange ---- - -启用低功耗蓝牙设备特征值变化时的 notify 功能，订阅特征值。注意：必须设备的特征值支持 notify 或者 indicate 才可以成功调用。 - -另外，必须先启用 `notifyBLECharacteristicValueChange` 才能监听到设备 `characteristicValueChange` 事件 - -**注意** -- 订阅操作成功后需要设备主动更新特征值的 value，才会触发 Taro.onBLECharacteristicValueChange 回调。 -- 安卓平台上，在调用 `notifyBLECharacteristicValueChange` 成功后立即调用 `writeBLECharacteristicValue` 接口，在部分机型上会发生 10008 系统错误 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| characteristicId | `string` | | 是 | 蓝牙特征值的 uuid | -| deviceId | `string` | | 是 | 蓝牙设备 id | -| serviceId | `string` | | 是 | 蓝牙特征值对应服务的 uuid | -| state | `boolean` | | 是 | 是否启用 notify | -| type | `keyof Type` | `"indication"` | 否 | 设置特征订阅类型，有效值有 notification 和 indication | -| complete | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用成功的回调函数 | - -### Type - -## 示例代码 - -```tsx -Taro.notifyBLECharacteristicValueChange({ - state: true, // 启用 notify 功能 - // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 - deviceId, - // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取 - serviceId, - // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取 - characteristicId, - success: function (res) { - console.log('notifyBLECharacteristicValueChange success', res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLECharacteristicValueChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLECharacteristicValueChange.md deleted file mode 100644 index a91e92ea10b8..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLECharacteristicValueChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBLECharacteristicValueChange(callback) -sidebar_label: offBLECharacteristicValueChange ---- - -取消监听蓝牙低功耗设备的特征值变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.offBLECharacteristicValueChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 低功耗蓝牙设备的特征值变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEConnectionStateChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEConnectionStateChange.md deleted file mode 100644 index 9277cc48a735..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEConnectionStateChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBLEConnectionStateChange(callback) -sidebar_label: offBLEConnectionStateChange ---- - -取消监听蓝牙低功耗连接状态的改变事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.offBLEConnectionStateChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 蓝牙低功耗连接状态的改变事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEMTUChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEMTUChange.md deleted file mode 100644 index a37526dbc229..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/offBLEMTUChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBLEMTUChange(callback) -sidebar_label: offBLEMTUChange ---- - -取消监听蓝牙低功耗的最大传输单元变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.offBLEMTUChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 蓝牙低功耗的最大传输单元变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLECharacteristicValueChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLECharacteristicValueChange.md deleted file mode 100644 index 3f1e7ed28348..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLECharacteristicValueChange.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Taro.onBLECharacteristicValueChange(callback) -sidebar_label: onBLECharacteristicValueChange ---- - -监听低功耗蓝牙设备的特征值变化事件。必须先启用 `notifyBLECharacteristicValueChange` 接口才能接收到设备推送的 notification。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 低功耗蓝牙设备的特征值变化事件的回调函数 | - -### Callback - -低功耗蓝牙设备的特征值变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| characteristicId | `string` | 蓝牙特征值的 uuid | -| deviceId | `string` | 蓝牙设备 id | -| serviceId | `string` | 蓝牙特征值对应服务的 uuid | -| value | `ArrayBuffer` | 特征值最新的值 | - -## 示例代码 - -```tsx -// ArrayBuffer转16进制字符串示例 -function ab2hex(buffer) { - let hexArr = Array.prototype.map.call( - new Uint8Array(buffer), - function(bit) { - return ('00' + bit.toString(16)).slice(-2) - } - ) - return hexArr.join(''); -} -Taro.onBLECharacteristicValueChange(function (res) { - console.log(`characteristic ${res.characteristicId} has changed, now is ${res.value}`) - console.log(ab2hex(res.value)) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEConnectionStateChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEConnectionStateChange.md deleted file mode 100644 index a72cb29bd223..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEConnectionStateChange.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.onBLEConnectionStateChange(callback) -sidebar_label: onBLEConnectionStateChange ---- - -监听低功耗蓝牙连接状态的改变事件。包括开发者主动连接或断开连接，设备丢失，连接异常断开等等 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 低功耗蓝牙连接状态的改变事件的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| connected | `boolean` | 是否处于已连接状态 | -| deviceId | `string` | 蓝牙设备ID | - -### Callback - -低功耗蓝牙连接状态的改变事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -## 示例代码 - -```tsx -Taro.onBLEConnectionStateChange(function (res) { - // 该方法回调中可以用于处理连接意外断开等异常情况 - console.log(`device ${res.deviceId} state has changed, connected: ${res.connected}`) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEMTUChange.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEMTUChange.md deleted file mode 100644 index b09ddace276a..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/onBLEMTUChange.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.onBLEMTUChange(callback) -sidebar_label: onBLEMTUChange ---- - -监听蓝牙低功耗的最大传输单元变化事件（仅安卓触发） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 蓝牙低功耗的最大传输单元变化事件的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| deviceId | `string` | 蓝牙设备ID | -| mtu | `string` | 最大传输单元 | - -### Callback - -蓝牙低功耗的最大传输单元变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -## 示例代码 - -```tsx -Taro.onBLEMTUChange(function (res) { - console.log('bluetooth mtu is', res.mtu) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/readBLECharacteristicValue.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/readBLECharacteristicValue.md deleted file mode 100644 index 9762482baec2..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/readBLECharacteristicValue.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.readBLECharacteristicValue(option) -sidebar_label: readBLECharacteristicValue ---- - -读取低功耗蓝牙设备的特征值的二进制数据值。注意：必须设备的特征值支持 read 才可以成功调用。 - -**注意** -- 并行调用多次会存在读失败的可能性。 -- 接口读取到的信息需要在 `onBLECharacteristicValueChange` 方法注册的回调中获取。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.readBLECharacteristicValue.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| characteristicId | `string` | 是 | 蓝牙特征值的 uuid | -| deviceId | `string` | 是 | 蓝牙设备 id | -| serviceId | `string` | 是 | 蓝牙特征值对应服务的 uuid | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -// 必须在这里的回调才能获取 -Taro.onBLECharacteristicValueChange(function(characteristic) { - console.log('characteristic value comed:', characteristic) -}) -Taro.readBLECharacteristicValue({ - // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 - deviceId, - // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取 - serviceId, - // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取 - characteristicId, - success: function (res) { - console.log('readBLECharacteristicValue:', res.errCode) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/setBLEMTU.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/setBLEMTU.md deleted file mode 100644 index be59baf428c2..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/setBLEMTU.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.setBLEMTU(option) -sidebar_label: setBLEMTU ---- - -协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU) - -- 需在 Taro.createBLEConnection 调用成功后调用 -- 仅安卓系统 5.1 以上版本有效，iOS 因系统限制不支持。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.setBLEMTU.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -```tsx -FailCallbackResult | SuccessCallbackResult -``` - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 蓝牙设备 id | -| mtu | `number` | 是 | 最大传输单元。设置范围为 (22,512) 区间内，单位 bytes | -| complete | `(res: Promised) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mtu | `string` | 最终协商的 MTU 值。如果协商失败则无此参数。安卓客户端 8.0.9 开始支持。 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mtu | `string` | 最终协商的 MTU 值，与传入参数一致。安卓客户端 8.0.9 开始支持。 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-ble/writeBLECharacteristicValue.md b/versioned_docs/version-4.x/apis/device/bluetooth-ble/writeBLECharacteristicValue.md deleted file mode 100644 index 9ed0a53bde6e..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-ble/writeBLECharacteristicValue.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Taro.writeBLECharacteristicValue(option) -sidebar_label: writeBLECharacteristicValue ---- - -向低功耗蓝牙设备特征值中写入二进制数据。注意：必须设备的特征值支持 write 才可以成功调用。 - -**注意** -- 并行调用多次会存在写失败的可能性。 -- 小程序不会对写入数据包大小做限制，但系统与蓝牙设备会限制蓝牙4.0单次传输的数据大小，超过最大字节数后会发生写入错误，建议每次写入不超过20字节。 -- 若单次写入数据过长，iOS 上存在系统不会有任何回调的情况（包括错误回调）。 -- 安卓平台上，在调用 `notifyBLECharacteristicValueChange` 成功后立即调用 `writeBLECharacteristicValue` 接口，在部分机型上会发生 10008 系统错误 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| characteristicId | `string` | 是 | 蓝牙特征值的 uuid | -| deviceId | `string` | 是 | 蓝牙设备 id | -| serviceId | `string` | 是 | 蓝牙特征值对应服务的 uuid | -| value | `ArrayBuffer` | 是 | 蓝牙设备特征值对应的二进制值 | -| writeType | `keyof WriteType` | 否 | 蓝牙特征值的写模式设置，有两种模式，iOS 优先 write，安卓优先 writeNoResponse 。（基础库 2.22.0 开始支持） | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### WriteType - -| 参数 | 说明 | -| --- | --- | -| write | 强制回复写，不支持时报错 | -| writeNoResponse | 强制无回复写，不支持时报错 | - -## 示例代码 - -```tsx -// 向蓝牙设备发送一个0x00的16进制数据 -let buffer = new ArrayBuffer(1) -let dataView = new DataView(buffer) -dataView.setUint8(0, 0) -Taro.writeBLECharacteristicValue({ - // 这里的 deviceId 需要在 getBluetoothDevices 或 onBluetoothDeviceFound 接口中获取 - deviceId, - // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取 - serviceId, - // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取 - characteristicId, - // 这里的value是ArrayBuffer类型 - value: buffer, - success: function (res) { - console.log('writeBLECharacteristicValue success', res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/BLEPeripheralServer.md b/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/BLEPeripheralServer.md deleted file mode 100644 index baa352964ab7..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/BLEPeripheralServer.md +++ /dev/null @@ -1,517 +0,0 @@ ---- -title: BLEPeripheralServer -sidebar_label: BLEPeripheralServer ---- - -外围设备的服务端 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.html) - -## 方法 - -### addService - -添加服务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.addService.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### close - -关闭当前服务端 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.close.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### offCharacteristicReadRequest - -取消监听已连接的设备请求读当前外围设备的特征值事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicReadRequest.html) - -```tsx -(callback?: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 已连接的设备请求读当前外围设备的特征值事件的回调函数 | - -### offCharacteristicSubscribed - -取消监听特征订阅事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicSubscribed.html) - -```tsx -(callback?: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 特征订阅事件的回调函数 | - -### offCharacteristicUnsubscribed - -取消监听取消特征订阅事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicUnsubscribed.html) - -```tsx -(callback?: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 取消特征订阅事件的回调函数 | - -### offCharacteristicWriteRequest - -取消监听已连接的设备请求写当前外围设备的特征值事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicWriteRequest.html) - -```tsx -(callback?: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 已连接的设备请求写当前外围设备的特征值事件的回调函数 | - -### onCharacteristicReadRequest - -监听已连接的设备请求读当前外围设备的特征值事件 - -收到该消息后需要立刻调用 [writeCharacteristicValue](/docs/apis/device/bluetooth-peripheral/BLEPeripheralServer#writecharacteristicvalue) 写回数据，否则主机不会收到响应。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicReadRequest.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 已连接的设备请求读当前外围设备的特征值事件的回调函数 | - -### onCharacteristicSubscribed - -监听特征订阅事件，仅 iOS 支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicSubscribed.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 特征订阅事件的回调函数 | - -### onCharacteristicUnsubscribed - -监听取消特征订阅事件，仅 iOS 支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicUnsubscribed.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 取消特征订阅事件的回调函数 | - -### onCharacteristicWriteRequest - -监听已连接的设备请求写当前外围设备的特征值事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicWriteRequest.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 已连接的设备请求写当前外围设备的特征值事件的回调函数 | - -### removeService - -移除服务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.removeService.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### startAdvertising - -开始广播本地创建的外围设备 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.startAdvertising.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### stopAdvertising - -停止广播 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.stopAdvertising.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### writeCharacteristicValue - -往指定特征写入二进制数据值，并通知已连接的主机，从机的特征值已发生变化，该接口会处理是走回包还是走订阅 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### addService - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| service | `service` | 是 | 描述 service 的 Object | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -#### service - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| uuid | `string` | 蓝牙服务的 UUID | -| characteristics | `characteristic[]` | characteristics 列表 | - -#### characteristic - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| uuid | `string` | 是 | characteristic 的 UUID | -| properties | `properties` | 否 | 特征支持的操作 | -| permission | `characteristicPermission` | 否 | 特征权限 | -| value | `ArrayBuffer` | 否 | 特征对应的二进制值 | -| descriptors | `descriptor[]` | 否 | 描述符数据 | - -#### properties - -特征支持的操作 - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| write | `boolean` | `false` | 否 | 写 | -| writeNoResponse | `boolean` | `false` | 否 | 无回复写 | -| read | `boolean` | `false` | 否 | 读 | -| notify | `boolean` | `false` | 否 | 订阅 | -| indicate | `boolean` | `false` | 否 | 回包 | - -#### characteristicPermission - -特征权限 - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| readable | `boolean` | `false` | 否 | 可读 | -| writeable | `boolean` | `false` | 否 | 可写 | -| readEncryptionRequired | `boolean` | `false` | 否 | 加密读请求 | -| writeEncryptionRequired | `boolean` | `false` | 否 | 加密写请求 | - -#### descriptor - -描述符数据 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| uuid | `string` | 是 | Descriptor 的 UUID | -| permission | `descriptorPermission` | 否 | 描述符的权限 | -| value | `ArrayBuffer` | 是 | 描述符数据 | - -#### descriptorPermission - -描述符的权限 - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| write | `boolean` | `false` | 否 | 写 | -| read | `boolean` | `false` | 否 | 读 | - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### onCharacteristicReadRequest - -#### Callback - -已连接的设备请求读当前外围设备的特征值事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceId | `string` | 蓝牙特征对应服务的 UUID | -| characteristicId | `string` | 蓝牙特征的 UUID | -| callbackId | `number` | 唯一标识码，调用 [writeCharacteristicValue](/docs/apis/device/bluetooth-peripheral/BLEPeripheralServer#writecharacteristicvalue) 时使用 | - -### onCharacteristicSubscribed - -#### Callback - -特征订阅事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceId | `string` | 蓝牙特征对应服务的 UUID | -| characteristicId | `string` | 蓝牙特征的 UUID | - -### onCharacteristicUnsubscribed - -#### Callback - -取消特征订阅事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceId | `string` | 蓝牙特征对应服务的 UUID | -| characteristicId | `string` | 蓝牙特征的 UUID | - -### onCharacteristicWriteRequest - -#### Callback - -已连接的设备请求写当前外围设备的特征值事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceId | `string` | 蓝牙特征对应服务的 UUID | -| characteristicId | `string` | 蓝牙特征的 UUID | -| callbackId | `number` | 唯一标识码，调用 [writeCharacteristicValue](/docs/apis/device/bluetooth-peripheral/BLEPeripheralServer#writecharacteristicvalue) 时使用 | -| value | `ArrayBuffer` | 请求写入特征的二进制数据值 | - -### removeService - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| serviceId | `string` | 是 | service 的 UUID | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### startAdvertising - -#### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| advertiseRequest | `advertiseRequest` | | 是 | 广播自定义参数 | -| powerLevel | `keyof PowerLevel` | `"medium"` | 否 | 广播功率 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | | 否 | 接口调用成功的回调函数 | - -#### advertiseRequest - -广播自定义参数 - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| connectable | `boolean` | `true` | 否 | 当前设备是否可连接 | -| deviceName | `string` | `""` | 否 | 广播中 deviceName 字段，默认为空 | -| serviceUuids | `string[]` | | 否 | 要广播的服务 UUID 列表。使用 16/32 位 UUID 时请参考注意事项。 | -| manufacturerData | `manufacturerData[]` | | 否 | 广播的制造商信息。仅安卓支持，iOS 因系统限制无法定制。 | -| beacon | `beacon` | | 否 | 以 beacon 设备形式广播的参数。 | - -#### manufacturerData - -广播的制造商信息。仅安卓支持，iOS 因系统限制无法定制。 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| manufacturerId | `string` | 是 | 制造商ID，0x 开头的十六进制 | -| manufacturerSpecificData | `ArrayBuffer` | 否 | 制造商信息 | - -#### beacon - -以 beacon 设备形式广播的参数。 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| uuid | `string` | 是 | Beacon 设备广播的 UUID | -| major | `number` | 是 | Beacon 设备的主 ID | -| minor | `number` | 是 | Beacon 设备的次 ID | -| measuredPower | `number` | 否 | 用于判断距离设备 1 米时 RSSI 大小的参考值 | - -#### PowerLevel - -广播功率合法值 - -| 参数 | 说明 | -| --- | --- | -| low | 功率低 | -| medium | 功率适中 | -| high | 功率高 | - -### stopAdvertising - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### writeCharacteristicValue - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| serviceId | `string` | 是 | 蓝牙特征对应服务的 UUID | -| characteristicId | `string` | 是 | 蓝牙特征的 UUID | -| value | `ArrayBuffer` | 是 | characteristic 对应的二进制值 | -| needNotify | `boolean` | 是 | 是否需要通知主机 value 已更新 | -| callbackId | `number` | 否 | 可选，处理回包时使用 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | 京东小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| BLEPeripheralServer | ✔️ | | | | | -| BLEPeripheralServer.addService | ✔️ | ✔️ | | | | -| BLEPeripheralServer.close | ✔️ | | | | | -| BLEPeripheralServer.offCharacteristicReadRequest | ✔️ | ✔️ | | | | -| BLEPeripheralServer.offCharacteristicSubscribed | ✔️ | ✔️ | | | | -| BLEPeripheralServer.offCharacteristicUnsubscribed | ✔️ | | | | | -| BLEPeripheralServer.offCharacteristicWriteRequest | ✔️ | ✔️ | | | | -| BLEPeripheralServer.onCharacteristicReadRequest | ✔️ | ✔️ | | | | -| BLEPeripheralServer.onCharacteristicSubscribed | ✔️ | ✔️ | | | | -| BLEPeripheralServer.onCharacteristicUnsubscribed | ✔️ | ✔️ | | | | -| BLEPeripheralServer.onCharacteristicWriteRequest | ✔️ | ✔️ | | | | -| BLEPeripheralServer.removeService | ✔️ | ✔️ | | | | -| BLEPeripheralServer.startAdvertising | ✔️ | ✔️ | | | | -| BLEPeripheralServer.stopAdvertising | ✔️ | ✔️ | | | | -| BLEPeripheralServer.writeCharacteristicValue | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/createBLEPeripheralServer.md b/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/createBLEPeripheralServer.md deleted file mode 100644 index 88a0f9a571c8..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/createBLEPeripheralServer.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.createBLEPeripheralServer(option) -sidebar_label: createBLEPeripheralServer ---- - -建立本地作为蓝牙低功耗外围设备的服务端，可创建多个 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/wx.createBLEPeripheralServer.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| server | `BLEPeripheralServer` | 外围设备的服务端 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/offBLEPeripheralConnectionStateChanged.md b/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/offBLEPeripheralConnectionStateChanged.md deleted file mode 100644 index 690cf2b0dccd..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/offBLEPeripheralConnectionStateChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBLEPeripheralConnectionStateChanged(callback) -sidebar_label: offBLEPeripheralConnectionStateChanged ---- - -取消监听当前外围设备被连接或断开连接事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/wx.offBLEPeripheralConnectionStateChanged.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当前外围设备被连接或断开连接事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/onBLEPeripheralConnectionStateChanged.md b/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/onBLEPeripheralConnectionStateChanged.md deleted file mode 100644 index 0e9b34d09c51..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth-peripheral/onBLEPeripheralConnectionStateChanged.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onBLEPeripheralConnectionStateChanged(callback) -sidebar_label: onBLEPeripheralConnectionStateChanged ---- - -监听当前外围设备被连接或断开连接事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-peripheral/wx.onBLEPeripheralConnectionStateChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听当前外围设备被连接或断开连接事件 | - -### Callback - -当前外围设备被连接或断开连接事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| deviceId | `string` | 蓝牙设备 id | -| serverId | `string` | server 的 UUID | -| connected | `boolean` | 连接目前状态 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/closeBluetoothAdapter.md b/versioned_docs/version-4.x/apis/device/bluetooth/closeBluetoothAdapter.md deleted file mode 100644 index c34f93061dbb..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/closeBluetoothAdapter.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.closeBluetoothAdapter(option) -sidebar_label: closeBluetoothAdapter ---- - -关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后，与 Taro.openBluetoothAdapter 成对调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.closeBluetoothAdapter.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.closeBluetoothAdapter({ - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothAdapterState.md b/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothAdapterState.md deleted file mode 100644 index 997c9cd689f0..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothAdapterState.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.getBluetoothAdapterState(option) -sidebar_label: getBluetoothAdapterState ---- - -获取本机蓝牙适配器状态。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.getBluetoothAdapterState.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| available | `boolean` | 蓝牙适配器是否可用 | -| discovering | `boolean` | 是否正在搜索设备 | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -## 示例代码 - -```tsx -Taro.getBluetoothAdapterState({ - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothDevices.md b/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothDevices.md deleted file mode 100644 index 275da7ba91e4..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/getBluetoothDevices.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Taro.getBluetoothDevices(option) -sidebar_label: getBluetoothDevices ---- - -获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备。 - -**注意事项** -- 该接口获取到的设备列表为**蓝牙模块生效期间所有搜索到的蓝牙设备**，若在蓝牙模块使用流程结束后未及时调用 Taro.closeBluetoothAdapter 释放资源，会存在调用该接口会返回之前的蓝牙使用流程中搜索到的蓝牙设备，可能设备已经不在用户身边，无法连接。 -- 蓝牙设备在被搜索到时，系统返回的 name 字段一般为广播包中的 LocalName 字段中的设备名称，而如果与蓝牙设备建立连接，系统返回的 name 字段会改为从蓝牙设备上获取到的 `GattName`。若需要动态改变设备名称并展示，建议使用 `localName` 字段。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.getBluetoothDevices.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| devices | `SuccessCallbackResultBlueToothDevice[]` | uuid 对应的的已连接设备列表 | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### SuccessCallbackResultBlueToothDevice - -uuid 对应的的已连接设备列表 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| RSSI | `number` | 是 | 当前蓝牙设备的信号强度 | -| advertisData | `ArrayBuffer` | 是 | 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。 | -| advertisServiceUUIDs | `string[]` | 是 | 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段 | -| deviceId | `string` | 是 | 用于区分设备的 id | -| localName | `string` | 是 | 当前蓝牙设备的广播数据段中的 LocalName 数据段 | -| name | `string` | 是 | 蓝牙设备名称，某些设备可能没有 | -| serviceData | `TaroGeneral.IAnyObject` | 是 | 当前蓝牙设备的广播数据段中的 ServiceData 数据段 | -| connectable | `boolean` | 否 | 当前蓝牙设备是否可连接（ Android 8.0 以下不支持返回该值 ） | - -## 示例代码 - -```tsx -// ArrayBuffer转16进度字符串示例 -function ab2hex(buffer) { - var hexArr = Array.prototype.map.call( - new Uint8Array(buffer), - function(bit) { - return ('00' + bit.toString(16)).slice(-2) - } - ) - return hexArr.join(''); -} -Taro.getBluetoothDevices({ - success: function (res) { - console.log(res) - if (res.devices[0]) { - console.log(ab2hex(res.devices[0].advertisData)) - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/getConnectedBluetoothDevices.md b/versioned_docs/version-4.x/apis/device/bluetooth/getConnectedBluetoothDevices.md deleted file mode 100644 index bf959aaf6269..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/getConnectedBluetoothDevices.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.getConnectedBluetoothDevices(option) -sidebar_label: getConnectedBluetoothDevices ---- - -根据 uuid 获取处于已连接状态的设备。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.getConnectedBluetoothDevices.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| services | `string[]` | 是 | 蓝牙设备主 service 的 uuid 列表 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| devices | `BluetoothDeviceInfo[]` | 搜索到的设备列表 | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### BluetoothDeviceInfo - -搜索到的设备 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| deviceId | `string` | 用于区分设备的 id | -| name | `string` | 蓝牙设备名称，某些设备可能没有 | - -## 示例代码 - -```tsx -Taro.getConnectedBluetoothDevices({ - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/isBluetoothDevicePaired.md b/versioned_docs/version-4.x/apis/device/bluetooth/isBluetoothDevicePaired.md deleted file mode 100644 index 406ffc3cf3d1..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/isBluetoothDevicePaired.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.isBluetoothDevicePaired(option) -sidebar_label: isBluetoothDevicePaired ---- - -查询蓝牙设备是否配对，仅安卓支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.isBluetoothDevicePaired.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| deviceId | `string` | 是 | 蓝牙设备 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/makeBluetoothPair.md b/versioned_docs/version-4.x/apis/device/bluetooth/makeBluetoothPair.md deleted file mode 100644 index 1943bbd19b56..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/makeBluetoothPair.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.makeBluetoothPair(option) -sidebar_label: makeBluetoothPair ---- - -蓝牙配对接口，仅安卓支持 - -通常情况下（需要指定 pin 码或者密码时）系统会接管配对流程，直接调用 [Taro.createBLEConnection](/docs/apis/device/bluetooth-ble/createBLEConnection) 即可。该接口只应当在开发者不想让用户手动输入 pin 码且真机验证确认可以正常生效情况下用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.makeBluetoothPair.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| deviceId | `string` | | 是 | 蓝牙设备 id | -| pin | `string` | | 是 | pin 码，Base64 格式 | -| timeout | `string` | `20000` | 否 | 超时时间，单位 ms | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothAdapterStateChange.md b/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothAdapterStateChange.md deleted file mode 100644 index a8f829fd3b5e..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothAdapterStateChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBluetoothAdapterStateChange(callback) -sidebar_label: offBluetoothAdapterStateChange ---- - -取消监听蓝牙适配器状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.offBluetoothAdapterStateChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 蓝牙适配器状态变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothDeviceFound.md b/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothDeviceFound.md deleted file mode 100644 index 48c78cd1a033..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/offBluetoothDeviceFound.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBluetoothDeviceFound(callback) -sidebar_label: offBluetoothDeviceFound ---- - -取消监听寻找到新设备的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.offBluetoothDeviceFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 寻找到新设备的事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothAdapterStateChange.md b/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothAdapterStateChange.md deleted file mode 100644 index 0684683c49a2..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothAdapterStateChange.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.onBluetoothAdapterStateChange(callback) -sidebar_label: onBluetoothAdapterStateChange ---- - -监听蓝牙适配器状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.onBluetoothAdapterStateChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 蓝牙适配器状态变化事件的回调函数 | - -### Callback - -蓝牙适配器状态变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| available | `boolean` | 蓝牙适配器是否可用 | -| discovering | `boolean` | 蓝牙适配器是否处于搜索状态 | - -## 示例代码 - -```tsx -Taro.onBluetoothAdapterStateChange(function (res) { - console.log('adapterState changed, now is', res) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothDeviceFound.md b/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothDeviceFound.md deleted file mode 100644 index eb1e6784d018..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/onBluetoothDeviceFound.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Taro.onBluetoothDeviceFound(callback) -sidebar_label: onBluetoothDeviceFound ---- - -监听寻找到新设备的事件 - -**注意** -- 若在 Taro.onBluetoothDeviceFound 回调了某个设备，则此设备会添加到 Taro.getBluetoothDevices 接口获取到的数组中。 -- 安卓下部分机型需要有位置权限才能搜索到设备，需留意是否开启了位置权限 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.onBluetoothDeviceFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 寻找到新设备的事件的回调函数 | - -### Callback - -寻找到新设备的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| devices | `CallbackResultBlueToothDevice[]` | 新搜索到的设备列表 | - -### CallbackResultBlueToothDevice - -新搜索到的设备 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| RSSI | `number` | 是 | 当前蓝牙设备的信号强度，单位 dBm | -| advertisData | `ArrayBuffer` | 是 | 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。 | -| advertisServiceUUIDs | `string[]` | 是 | 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段 | -| deviceId | `string` | 是 | 用于区分设备的 id | -| localName | `string` | 是 | 当前蓝牙设备的广播数据段中的 LocalName 数据段 | -| name | `string` | 是 | 蓝牙设备名称，某些设备可能没有 | -| serviceData | `TaroGeneral.IAnyObject` | 是 | 当前蓝牙设备的广播数据段中的 ServiceData 数据段 | -| connectable | `boolean` | 否 | 当前蓝牙设备是否可连接（ Android 8.0 以下不支持返回该值 ） | - -## 示例代码 - -```tsx -// ArrayBuffer转16进度字符串示例 -function ab2hex(buffer) { - var hexArr = Array.prototype.map.call( - new Uint8Array(buffer), - function(bit) { - return ('00' + bit.toString(16)).slice(-2) - } - ) - return hexArr.join(''); -} -Taro.onBluetoothDeviceFound(function (res) { - var devices = res.devices; - console.log('new device list has founded') - console.dir(devices) - console.log(ab2hex(devices[0].advertisData)) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/openBluetoothAdapter.md b/versioned_docs/version-4.x/apis/device/bluetooth/openBluetoothAdapter.md deleted file mode 100644 index 757c8f6ddd73..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/openBluetoothAdapter.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Taro.openBluetoothAdapter(option) -sidebar_label: openBluetoothAdapter ---- - -初始化蓝牙模块 - -**注意** -- 其他蓝牙相关 API 必须在 Taro.openBluetoothAdapter 调用之后使用。否则 API 会返回错误（errCode=10000）。 -- 在用户蓝牙开关未开启或者手机不支持蓝牙功能的情况下，调用 Taro.openBluetoothAdapter 监听手机蓝牙状态的改变，也可以调用蓝牙模块的所有API。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| mode | `keyof Mode` | 否 | 蓝牙模式，可作为主/从设备，仅 iOS 需要。 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### Mode - -| 参数 | 说明 | -| --- | --- | -| central | 主机模式 | -| peripheral | 从机（外围设备）模式 | - -### state - -object.fail 回调函数返回的 state 参数（仅 iOS） - -| 参数 | 说明 | -| --- | --- | -| 0 | 未知 | -| 1 | 重置中 | -| 2 | 不支持 | -| 3 | 未授权 | -| 4 | 未开启 | - -## 示例代码 - -```tsx -Taro.openBluetoothAdapter({ - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/startBluetoothDevicesDiscovery.md b/versioned_docs/version-4.x/apis/device/bluetooth/startBluetoothDevicesDiscovery.md deleted file mode 100644 index 366525c6cdaa..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/startBluetoothDevicesDiscovery.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Taro.startBluetoothDevicesDiscovery(option) -sidebar_label: startBluetoothDevicesDiscovery ---- - -开始搜寻附近的蓝牙外围设备。**此操作比较耗费系统资源，请在搜索并连接到设备后调用 Taro.stopBluetoothDevicesDiscovery 方法停止搜索。** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.startBluetoothDevicesDiscovery.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| allowDuplicatesKey | `boolean` | 否 | 是否允许重复上报同一设备。如果允许重复上报，则 Taro.onBlueToothDeviceFound 方法会多次上报同一设备，但是 RSSI 值会有不同。 | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| interval | `number` | 否 | 上报设备的间隔。0 表示找到新设备立即上报，其他数值根据传入的间隔上报。 | -| services | `string[]` | 否 | 要搜索的蓝牙设备主 service 的 uuid 列表。某些蓝牙设备会广播自己的主 service 的 uuid。如果设置此参数，则只搜索广播包有对应 uuid 的主服务的蓝牙设备。建议主要通过该参数过滤掉周边不需要处理的其他蓝牙设备。 | -| powerLevel | `keyof PowerLevel` | 否 | 扫描模式，越高扫描越快，也越耗电。仅安卓微信客户端 7.0.12 及以上支持。 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -### PowerLevel - -| 参数 | 说明 | -| --- | --- | -| low | 低 | -| medium | 中 | -| high | 高 | - -## 示例代码 - -```tsx -// 以微信硬件平台的蓝牙智能灯为例，主服务的 UUID 是 FEE7。传入这个参数，只搜索主服务 UUID 为 FEE7 的设备 -Taro.startBluetoothDevicesDiscovery({ - services: ['FEE7'], - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/bluetooth/stopBluetoothDevicesDiscovery.md b/versioned_docs/version-4.x/apis/device/bluetooth/stopBluetoothDevicesDiscovery.md deleted file mode 100644 index fad00da80c7d..000000000000 --- a/versioned_docs/version-4.x/apis/device/bluetooth/stopBluetoothDevicesDiscovery.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.stopBluetoothDevicesDiscovery(option) -sidebar_label: stopBluetoothDevicesDiscovery ---- - -停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时，建议调用该接口停止蓝牙搜索。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 成功：ok，错误：详细信息 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.BluetoothError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopBluetoothDevicesDiscovery({ - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/calendar/addPhoneCalendar.md b/versioned_docs/version-4.x/apis/device/calendar/addPhoneCalendar.md deleted file mode 100644 index b363bcd0ede5..000000000000 --- a/versioned_docs/version-4.x/apis/device/calendar/addPhoneCalendar.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.addPhoneCalendar(option) -sidebar_label: addPhoneCalendar ---- - -向系统日历添加事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/calendar/wx.addPhoneCalendar.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| title | `string` | | 是 | 日历事件标题 | -| startTime | `number` | | 是 | 开始时间的 unix 时间戳 (1970年1月1日开始所经过的秒数) | -| allDay | `boolean` | `false` | 否 | 是否全天事件 | -| description | `string` | | 否 | 事件说明 | -| location | `string` | | 否 | 事件位置 | -| endTime | `string` | | 否 | 结束时间的 unix 时间戳，默认与开始时间相同 | -| alarm | `boolean` | `true` | 否 | 是否提醒 | -| alarmOffset | `number` | `0` | 否 | 提醒提前量，单位秒，默认 0 表示开始时提醒 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/calendar/addPhoneRepeatCalendar.md b/versioned_docs/version-4.x/apis/device/calendar/addPhoneRepeatCalendar.md deleted file mode 100644 index c798ea59efa3..000000000000 --- a/versioned_docs/version-4.x/apis/device/calendar/addPhoneRepeatCalendar.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.addPhoneRepeatCalendar(option) -sidebar_label: addPhoneRepeatCalendar ---- - -向系统日历添加重复事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/calendar/wx.addPhoneRepeatCalendar.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| title | `string` | | 是 | 日历事件标题 | -| startTime | `number` | | 是 | 开始时间的 unix 时间戳 (1970年1月1日开始所经过的秒数) | -| allDay | `boolean` | `false` | 否 | 是否全天事件 | -| description | `string` | | 否 | 事件说明 | -| location | `string` | | 否 | 事件位置 | -| endTime | `string` | | 否 | 结束时间的 unix 时间戳，默认与开始时间相同 | -| alarm | `boolean` | `true` | 否 | 是否提醒 | -| alarmOffset | `number` | `0` | 否 | 提醒提前量，单位秒，默认 0 表示开始时提醒 | -| repeatInterval | `keyof RepeatInterval` | `"month"` | 否 | 重复周期，默认 month 每月重复 | -| repeatEndTime | `number` | | 否 | 重复周期结束时间的 unix 时间戳，不填表示一直重复 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RepeatInterval - -| 参数 | 说明 | -| --- | --- | -| day | 每天重复 | -| week | 每周重复 | -| month | 每月重复。该模式日期不能大于 28 日 | -| year | 每年重复 | diff --git a/versioned_docs/version-4.x/apis/device/clipboard/getClipboardData.md b/versioned_docs/version-4.x/apis/device/clipboard/getClipboardData.md deleted file mode 100644 index 84e16c218a11..000000000000 --- a/versioned_docs/version-4.x/apis/device/clipboard/getClipboardData.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Taro.getClipboardData(res) -sidebar_label: getClipboardData ---- - -获取系统剪贴板内容 - -支持情况： - -> H5: 部分实现 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/clipboard/wx.getClipboardData.html) - -## 类型 - -```tsx -(res?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| res | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 调用信息 | -| data | `string` | 剪贴板的内容 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackOption) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `string` | 剪贴板的内容 | - -## 示例代码 - -```tsx -Taro.getClipboardData({ - success: function (res){ - console.log(res.data) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/clipboard/setClipboardData.md b/versioned_docs/version-4.x/apis/device/clipboard/setClipboardData.md deleted file mode 100644 index a15ef19e07d1..000000000000 --- a/versioned_docs/version-4.x/apis/device/clipboard/setClipboardData.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Taro.setClipboardData(option) -sidebar_label: setClipboardData ---- - -设置系统剪贴板的内容。调用成功后，会弹出 toast 提示"内容已复制"，持续 1.5s - -支持情况： - -> H5: 部分实现 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/clipboard/wx.setClipboardData.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 调用信息 | -| data | `string` | 剪贴板的内容 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `string` | 是 | 剪贴板的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setClipboardData({ - data: 'data', - success: function (res) { - Taro.getClipboardData({ - success: function (res) { - console.log(res.data) // data - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/compass/offCompassChange.md b/versioned_docs/version-4.x/apis/device/compass/offCompassChange.md deleted file mode 100644 index 8c922ceb0a82..000000000000 --- a/versioned_docs/version-4.x/apis/device/compass/offCompassChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offCompassChange(callback) -sidebar_label: offCompassChange ---- - -取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.offCompassChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 罗盘数据变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/compass/onCompassChange.md b/versioned_docs/version-4.x/apis/device/compass/onCompassChange.md deleted file mode 100644 index 1c2301d49e38..000000000000 --- a/versioned_docs/version-4.x/apis/device/compass/onCompassChange.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Taro.onCompassChange(callback) -sidebar_label: onCompassChange ---- - -监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听，可使用 Taro.stopCompass 停止监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.onCompassChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 罗盘数据变化事件的回调函数 | - -### Callback - -罗盘数据变化事件的回调函数 - -```tsx -(result: OnCompassChangeCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnCompassChangeCallbackResult` | - -### OnCompassChangeCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| accuracy | string or number | 精度

由于平台差异，accuracy 在 iOS/Android 的值不同。

- iOS：accuracy 是一个 number 类型的值，表示相对于磁北极的偏差。0 表示设备指向磁北，90 表示指向东，180 表示指向南，依此类推。
- Android：accuracy 是一个 string 类型的枚举值。 | -| direction | `number` | 面对的方向度数 | - -### accuracy - -| 参数 | 说明 | -| --- | --- | -| high | 高精度 | -| medium | 中等精度 | -| low | 低精度 | -| no-contact | 不可信，传感器失去连接 | -| unreliable | 不可信，原因未知 | -| unknow ${value} | 未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值 | - -## 示例代码 - -```tsx -Taro.onCompassChange(function (res) { - console.log(res.direction) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/compass/startCompass.md b/versioned_docs/version-4.x/apis/device/compass/startCompass.md deleted file mode 100644 index e630dda750a4..000000000000 --- a/versioned_docs/version-4.x/apis/device/compass/startCompass.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.startCompass(option) -sidebar_label: startCompass ---- - -开始监听罗盘数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.startCompass.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```js -Taro.startCompass() -``` diff --git a/versioned_docs/version-4.x/apis/device/compass/stopCompass.md b/versioned_docs/version-4.x/apis/device/compass/stopCompass.md deleted file mode 100644 index 3dc24a77146e..000000000000 --- a/versioned_docs/version-4.x/apis/device/compass/stopCompass.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.stopCompass(option) -sidebar_label: stopCompass ---- - -停止监听罗盘数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.stopCompass.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopCompass() -``` diff --git a/versioned_docs/version-4.x/apis/device/contact/addPhoneContact.md b/versioned_docs/version-4.x/apis/device/contact/addPhoneContact.md deleted file mode 100644 index a623e1cac288..000000000000 --- a/versioned_docs/version-4.x/apis/device/contact/addPhoneContact.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Taro.addPhoneContact(option) -sidebar_label: addPhoneContact ---- - -添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.addPhoneContact.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| firstName | `string` | 是 | 名字 | -| photoFilePath | `string` | 否 | 头像本地文件路径 | -| nickName | `string` | 否 | 昵称 | -| middleName | `string` | 否 | 中间名 | -| lastName | `string` | 否 | 姓氏 | -| remark | `string` | 否 | 备注 | -| mobilePhoneNumber | `string` | 否 | 手机号 | -| weChatNumber | `string` | 否 | 微信号 | -| addressCountry | `string` | 否 | 联系地址国家 | -| addressState | `string` | 否 | 联系地址省份 | -| addressCity | `string` | 否 | 联系地址城市 | -| addressStreet | `string` | 否 | 联系地址街道 | -| addressPostalCode | `string` | 否 | 联系地址邮政编码 | -| organization | `string` | 否 | 公司 | -| title | `string` | 否 | 职位 | -| workFaxNumber | `string` | 否 | 工作传真 | -| workPhoneNumber | `string` | 否 | 工作电话 | -| hostNumber | `string` | 否 | 公司电话 | -| email | `string` | 否 | 电子邮件 | -| url | `string` | 否 | 网站 | -| workAddressCountry | `string` | 否 | 工作地址国家 | -| workAddressState | `string` | 否 | 工作地址省份 | -| workAddressCity | `string` | 否 | 工作地址城市 | -| workAddressStreet | `string` | 否 | 工作地址街道 | -| workAddressPostalCode | `string` | 否 | 工作地址邮政编码 | -| homeFaxNumber | `string` | 否 | 住宅传真 | -| homePhoneNumber | `string` | 否 | 住宅电话 | -| homeAddressCountry | `string` | 否 | 住宅地址国家 | -| homeAddressState | `string` | 否 | 住宅地址省份 | -| homeAddressCity | `string` | 否 | 住宅地址城市 | -| homeAddressStreet | `string` | 否 | 住宅地址街道 | -| homeAddressPostalCode | `string` | 否 | 住宅地址邮政编码 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/contact/chooseContact.md b/versioned_docs/version-4.x/apis/device/contact/chooseContact.md deleted file mode 100644 index 41811763c584..000000000000 --- a/versioned_docs/version-4.x/apis/device/contact/chooseContact.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.chooseContact(option) -sidebar_label: chooseContact ---- - -添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.chooseContact.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| phoneNumber | `string` | 手机号 | -| displayName | `string` | 联系人姓名 | -| phoneNumberList | `string` | 选定联系人的所有手机号（部分 Android 系统只能选联系人而不能选特定手机号） | diff --git a/versioned_docs/version-4.x/apis/device/gyroscope/offGyroscopeChange.md b/versioned_docs/version-4.x/apis/device/gyroscope/offGyroscopeChange.md deleted file mode 100644 index eaf4095fca02..000000000000 --- a/versioned_docs/version-4.x/apis/device/gyroscope/offGyroscopeChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offGyroscopeChange(callback) -sidebar_label: offGyroscopeChange ---- - -取消监听陀螺仪数据变化事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.offGyroscopeChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 陀螺仪数据变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/gyroscope/onGyroscopeChange.md b/versioned_docs/version-4.x/apis/device/gyroscope/onGyroscopeChange.md deleted file mode 100644 index c9fe43ce4f26..000000000000 --- a/versioned_docs/version-4.x/apis/device/gyroscope/onGyroscopeChange.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onGyroscopeChange(callback) -sidebar_label: onGyroscopeChange ---- - -监听陀螺仪数据变化事件。频率根据 Taro.startGyroscope() 的 interval 参数。可以使用 Taro.stopGyroscope() 停止监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.onGyroscopeChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 陀螺仪数据变化事件的回调函数 | - -### Callback - -陀螺仪数据变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | x 轴的角速度 | -| y | `number` | y 轴的角速度 | -| z | `number` | z 轴的角速度 | diff --git a/versioned_docs/version-4.x/apis/device/gyroscope/startGyroscope.md b/versioned_docs/version-4.x/apis/device/gyroscope/startGyroscope.md deleted file mode 100644 index 15a3dd90b41a..000000000000 --- a/versioned_docs/version-4.x/apis/device/gyroscope/startGyroscope.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.startGyroscope(option) -sidebar_label: startGyroscope ---- - -开始监听陀螺仪数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.startGyroscope.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| interval | `keyof Interval` | 否 | 监听陀螺仪数据回调函数的执行频率 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### Interval - -监听陀螺仪数据回调函数的执行频率 - -| 参数 | 说明 | -| --- | --- | -| game | 适用于更新游戏的回调频率，在 20ms/次 左右 | -| ui | 适用于更新 UI 的回调频率，在 60ms/次 左右 | -| normal | 普通的回调频率，在 200ms/次 左右 | diff --git a/versioned_docs/version-4.x/apis/device/gyroscope/stopGyroscope.md b/versioned_docs/version-4.x/apis/device/gyroscope/stopGyroscope.md deleted file mode 100644 index 14e4b9d7337a..000000000000 --- a/versioned_docs/version-4.x/apis/device/gyroscope/stopGyroscope.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.stopGyroscope(option) -sidebar_label: stopGyroscope ---- - -停止监听陀螺仪数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.stopGyroscope.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/IBeaconInfo.md b/versioned_docs/version-4.x/apis/device/iBeacon/IBeaconInfo.md deleted file mode 100644 index 30edcd3ace5e..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/IBeaconInfo.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: IBeaconInfo -sidebar_label: IBeaconInfo ---- - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| uuid | `string` | Beacon 设备广播的 uuid | -| major | `string` | Beacon 设备的主 ID | -| minor | `string` | Beacon 设备的次 ID | -| proximity | `keyof Proximity` | 表示设备距离的枚举值（仅iOS） | -| accuracy | `number` | Beacon 设备的距离，单位 m。iOS 上，proximity 为 0 时，accuracy 为 -1。 | -| rssi | `number` | 表示设备的信号强度，单位 dBm | - -## 参数 - -### Proximity - -proximity 的合法值 - -| 参数 | 说明 | -| --- | --- | -| 0 | 信号太弱不足以计算距离，或非 iOS 设备 | -| 1 | 十分近 | -| 2 | 比较近 | -| 3 | 远 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/getBeacons.md b/versioned_docs/version-4.x/apis/device/iBeacon/getBeacons.md deleted file mode 100644 index 0279b972576b..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/getBeacons.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.getBeacons(option) -sidebar_label: getBeacons ---- - -获取所有已搜索到的 iBeacon 设备 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.getBeacons.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.IBeaconError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.IBeaconError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| beacons | `IBeaconInfo[]` | iBeacon 设备列表 | -| errMsg | `string` | 调用结果 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconServiceChange.md b/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconServiceChange.md deleted file mode 100644 index 3eaa3cd0a579..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconServiceChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBeaconServiceChange(callback) -sidebar_label: offBeaconServiceChange ---- - -取消监听 iBeacon 服务状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconServiceChange.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.IBeaconError) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.IBeaconError) => void` | iBeacon 服务状态变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconUpdate.md b/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconUpdate.md deleted file mode 100644 index a7dc98217901..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/offBeaconUpdate.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offBeaconUpdate(callback) -sidebar_label: offBeaconUpdate ---- - -取消监听 iBeacon 设备更新事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconUpdate.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.IBeaconError) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.IBeaconError) => void` | iBeacon 设备更新事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconServiceChange.md b/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconServiceChange.md deleted file mode 100644 index cdc76c506802..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconServiceChange.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.onBeaconServiceChange(callback) -sidebar_label: onBeaconServiceChange ---- - -监听 iBeacon 服务状态变化事件，仅能注册一个监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconServiceChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | iBeacon 服务状态变化事件的回调函数 | - -### Callback - -iBeacon 服务状态变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| available | `boolean` | 服务目前是否可用 | -| discovering | `boolean` | 目前是否处于搜索状态 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconUpdate.md b/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconUpdate.md deleted file mode 100644 index 879b807f43e9..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/onBeaconUpdate.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.onBeaconUpdate(callback) -sidebar_label: onBeaconUpdate ---- - -监听 iBeacon 设备更新事件，仅能注册一个监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconUpdate.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | iBeacon 设备更新事件的回调函数 | - -### Callback - -iBeacon 设备更新事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| beacons | `IBeaconInfo[]` | 当前搜寻到的所有 iBeacon 设备列表 | diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/startBeaconDiscovery.md b/versioned_docs/version-4.x/apis/device/iBeacon/startBeaconDiscovery.md deleted file mode 100644 index 2a2b386dd103..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/startBeaconDiscovery.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.startBeaconDiscovery(option) -sidebar_label: startBeaconDiscovery ---- - -开始搜索附近的 iBeacon 设备 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.startBeaconDiscovery.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| uuids | `string[]` | | 是 | iBeacon 设备广播的 uuid 列表 | -| complete | `(res: TaroGeneral.IBeaconError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.IBeaconError) => void` | | 否 | 接口调用失败的回调函数 | -| ignoreBluetoothAvailable | `boolean` | `false` | 否 | 是否校验蓝牙开关，仅在 iOS 下有效 | -| success | `(res: TaroGeneral.IBeaconError) => void` | | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startBeaconDiscovery({ - success: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/iBeacon/stopBeaconDiscovery.md b/versioned_docs/version-4.x/apis/device/iBeacon/stopBeaconDiscovery.md deleted file mode 100644 index 0eb653c62609..000000000000 --- a/versioned_docs/version-4.x/apis/device/iBeacon/stopBeaconDiscovery.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.stopBeaconDiscovery(option) -sidebar_label: stopBeaconDiscovery ---- - -停止搜索附近的 iBeacon 设备 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.IBeaconError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.IBeaconError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.IBeaconError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopBeaconDiscovery(params).then(...) -``` diff --git a/versioned_docs/version-4.x/apis/device/keyboard/getSelectedTextRange.md b/versioned_docs/version-4.x/apis/device/keyboard/getSelectedTextRange.md deleted file mode 100644 index 803004de27fe..000000000000 --- a/versioned_docs/version-4.x/apis/device/keyboard/getSelectedTextRange.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.getSelectedTextRange(option) -sidebar_label: getSelectedTextRange ---- - -在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.getSelectedTextRange.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| end | `number` | 输入框光标结束位置 | -| start | `number` | 输入框光标起始位置 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.getSelectedTextRange({ - complete: res => { - console.log('getSelectedTextRange res', res.start, res.end) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/keyboard/hideKeyboard.md b/versioned_docs/version-4.x/apis/device/keyboard/hideKeyboard.md deleted file mode 100644 index 26b57a902c2d..000000000000 --- a/versioned_docs/version-4.x/apis/device/keyboard/hideKeyboard.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.hideKeyboard(option) -sidebar_label: hideKeyboard ---- - -在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.hideKeyboard({ - complete: res => { - console.log('hideKeyboard res', res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/keyboard/offKeyboardHeightChange.md b/versioned_docs/version-4.x/apis/device/keyboard/offKeyboardHeightChange.md deleted file mode 100644 index 9ded00f741c0..000000000000 --- a/versioned_docs/version-4.x/apis/device/keyboard/offKeyboardHeightChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offKeyboardHeightChange(callback) -sidebar_label: offKeyboardHeightChange ---- - -取消监听键盘高度变化事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 键盘高度变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/keyboard/onKeyboardHeightChange.md b/versioned_docs/version-4.x/apis/device/keyboard/onKeyboardHeightChange.md deleted file mode 100644 index fe7c4ad1c585..000000000000 --- a/versioned_docs/version-4.x/apis/device/keyboard/onKeyboardHeightChange.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.onKeyboardHeightChange(callback) -sidebar_label: onKeyboardHeightChange ---- - -监听键盘高度变化 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Callback - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| height | `number` | 键盘高度 | - -## 示例代码 - -```tsx -Taro.onKeyboardHeightChange(res => { - console.log(res.height) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/memory/offMemoryWarning.md b/versioned_docs/version-4.x/apis/device/memory/offMemoryWarning.md deleted file mode 100644 index dd306b72d141..000000000000 --- a/versioned_docs/version-4.x/apis/device/memory/offMemoryWarning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offMemoryWarning(callback) -sidebar_label: offMemoryWarning ---- - -取消监听内存不足告警事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/memory/wx.offMemoryWarning.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 取消监听内存不足告警事件 | diff --git a/versioned_docs/version-4.x/apis/device/memory/onMemoryWarning.md b/versioned_docs/version-4.x/apis/device/memory/onMemoryWarning.md deleted file mode 100644 index 4b26c24f3857..000000000000 --- a/versioned_docs/version-4.x/apis/device/memory/onMemoryWarning.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.onMemoryWarning(callback) -sidebar_label: onMemoryWarning ---- - -监听内存不足告警事件。 - -当 iOS/Android 向小程序进程发出内存警告时，触发该事件。触发该事件不意味小程序被杀，大部分情况下仅仅是告警，开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/performance/wx.onMemoryWarning.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 内存不足告警事件的回调函数 | - -### Callback - -内存不足告警事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| level | `keyof Level` | 内存告警等级，只有 Android 才有，对应系统宏定义 | - -### Level - -| 参数 | 说明 | -| --- | --- | -| 5 | TRIM_MEMORY_RUNNING_MODERATE | -| 10 | TRIM_MEMORY_RUNNING_LOW | -| 15 | TRIM_MEMORY_RUNNING_CRITICAL | - -## 示例代码 - -```tsx -Taro.onMemoryWarning(function () { - console.log('onMemoryWarningReceive') -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/motion/offDeviceMotionChange.md b/versioned_docs/version-4.x/apis/device/motion/offDeviceMotionChange.md deleted file mode 100644 index d2d2ff32d13b..000000000000 --- a/versioned_docs/version-4.x/apis/device/motion/offDeviceMotionChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offDeviceMotionChange(callback) -sidebar_label: offDeviceMotionChange ---- - -取消监听设备方向变化事件，参数为空，则取消所有的事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.offDeviceMotionChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 设备方向变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/motion/onDeviceMotionChange.md b/versioned_docs/version-4.x/apis/device/motion/onDeviceMotionChange.md deleted file mode 100644 index 7cabac2f58fc..000000000000 --- a/versioned_docs/version-4.x/apis/device/motion/onDeviceMotionChange.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onDeviceMotionChange(callback) -sidebar_label: onDeviceMotionChange ---- - -监听设备方向变化事件。频率根据 Taro.startDeviceMotionListening() 的 interval 参数。可以使用 Taro.stopDeviceMotionListening() 停止监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.onDeviceMotionChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Callback - -设备方向变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| alpha | `number` | 当 手机坐标 X/Y 和 地球 X/Y 重合时，绕着 Z 轴转动的夹角为 alpha，范围值为 [0, 2*PI)。逆时针转动为正。 | -| beta | `number` | 当手机坐标 Y/Z 和地球 Y/Z 重合时，绕着 X 轴转动的夹角为 beta。范围值为 [-1*PI, PI) 。顶部朝着地球表面转动为正。也有可能朝着用户为正。 | -| gamma | `number` | 当手机 X/Z 和地球 X/Z 重合时，绕着 Y 轴转动的夹角为 gamma。范围值为 [-1*PI/2, PI/2)。右边朝着地球表面转动为正。 | diff --git a/versioned_docs/version-4.x/apis/device/motion/startDeviceMotionListening.md b/versioned_docs/version-4.x/apis/device/motion/startDeviceMotionListening.md deleted file mode 100644 index 76df360c8bb7..000000000000 --- a/versioned_docs/version-4.x/apis/device/motion/startDeviceMotionListening.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.startDeviceMotionListening(option) -sidebar_label: startDeviceMotionListening ---- - -开始监听设备方向的变化。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| interval | `keyof Interval` | `"normal"` | 否 | 监听设备方向的变化回调函数的执行频率 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### Interval - -| 参数 | 说明 | -| --- | --- | -| game | 适用于更新游戏的回调频率，在 20ms/次 左右 | -| ui | 适用于更新 UI 的回调频率，在 60ms/次 左右 | -| normal | 普通的回调频率，在 200ms/次 左右 | diff --git a/versioned_docs/version-4.x/apis/device/motion/stopDeviceMotionListening.md b/versioned_docs/version-4.x/apis/device/motion/stopDeviceMotionListening.md deleted file mode 100644 index f1aae4a537f2..000000000000 --- a/versioned_docs/version-4.x/apis/device/motion/stopDeviceMotionListening.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.stopDeviceMotionListening(option) -sidebar_label: stopDeviceMotionListening ---- - -停止监听设备方向的变化。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/network/getLocalIPAddress.md b/versioned_docs/version-4.x/apis/device/network/getLocalIPAddress.md deleted file mode 100644 index 5e0deb1ce930..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/getLocalIPAddress.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.getLocalIPAddress(option) -sidebar_label: getLocalIPAddress ---- - -获取局域网IP地址。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.getLocalIPAddress.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| localip | `string` | 是 | 本机局域网IP地址 | -| netmask | `string` | 否 | ，基础库 2.24.0 开始支持 | -| errMsg | `string` | 是 | 调用结果 | - -## 示例代码 - -```tsx -Taro.getLocalIPAddress() - .then(res => { - const localip = res.localip - }) -``` diff --git a/versioned_docs/version-4.x/apis/device/network/getNetworkType.md b/versioned_docs/version-4.x/apis/device/network/getNetworkType.md deleted file mode 100644 index 489ac4b73224..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/getNetworkType.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Taro.getNetworkType(option) -sidebar_label: getNetworkType ---- - -获取网络类型。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.getNetworkType.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| networkType | `keyof NetworkType` | 是 | 网络类型 | -| signalStrength | `number` | 否 | 信号强弱，单位 dbm | -| hasSystemProxy | `boolean` | 否 | 设备是否使用了网络代理 | -| errMsg | `string` | 是 | 调用结果 | - -### NetworkType - -网络类型 - -| 参数 | 说明 | -| --- | --- | -| wifi | wifi 网络 | -| 2g | 2g 网络 | -| 3g | 3g 网络 | -| 4g | 4g 网络 | -| 5g | 5g 网络 | -| unknown | Android 下不常见的网络类型 | -| none | 无网络 | - -## 示例代码 - -```tsx -Taro.getNetworkType({ - success: function (res) { - // 返回网络类型, 有效值： - // wifi/2g/3g/4g/unknown(Android下不常见的网络类型)/none(无网络) - var networkType = res.networkType - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/network/offNetworkStatusChange.md b/versioned_docs/version-4.x/apis/device/network/offNetworkStatusChange.md deleted file mode 100644 index aef103710a77..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/offNetworkStatusChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offNetworkStatusChange(callback) -sidebar_label: offNetworkStatusChange ---- - -取消监听网络状态变化事件，参数为空，则取消所有的事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkStatusChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 | diff --git a/versioned_docs/version-4.x/apis/device/network/offNetworkWeakChange.md b/versioned_docs/version-4.x/apis/device/network/offNetworkWeakChange.md deleted file mode 100644 index 81b9c9480423..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/offNetworkWeakChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offNetworkWeakChange(callback) -sidebar_label: offNetworkWeakChange ---- - -取消监听弱网状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkWeakChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 弱网状态变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/network/onNetworkStatusChange.md b/versioned_docs/version-4.x/apis/device/network/onNetworkStatusChange.md deleted file mode 100644 index 61c26b9383cb..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/onNetworkStatusChange.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.onNetworkStatusChange(callback) -sidebar_label: onNetworkStatusChange ---- - -监听网络状态变化。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.onNetworkStatusChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 网络状态变化事件的回调函数 | - -### Callback - -网络状态变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| isConnected | `boolean` | 当前是否有网络连接 | -| networkType | `keyof NetworkType` | 网络类型 | - -## 示例代码 - -```tsx -Taro.onNetworkStatusChange(function (res) { - console.log(res.isConnected) - console.log(res.networkType) -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/network/onNetworkWeakChange.md b/versioned_docs/version-4.x/apis/device/network/onNetworkWeakChange.md deleted file mode 100644 index a3e4ed183771..000000000000 --- a/versioned_docs/version-4.x/apis/device/network/onNetworkWeakChange.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Taro.onNetworkWeakChange(callback) -sidebar_label: onNetworkWeakChange ---- - -监听弱网状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.onNetworkWeakChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 弱网状态变化事件的回调函数 | - -### Callback - -弱网状态变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| weakNet | `boolean` | 当前是否处于弱网状态 | -| networkType | `keyof NetworkType` | 当前网络类型 | - -## 示例代码 - -```tsx -Taro.onNetworkWeakChange(function (res) { - console.log(res.weakNet) - console.log(res.networkType) -}) -// 取消监听 -Taro.offNetworkWeakChange() -``` diff --git a/versioned_docs/version-4.x/apis/device/nfc/IsoDep.md b/versioned_docs/version-4.x/apis/device/nfc/IsoDep.md deleted file mode 100644 index 73332b7f0450..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/IsoDep.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -title: IsoDep -sidebar_label: IsoDep ---- - -IsoDep 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getHistoricalBytes - -获取复位信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.getHistoricalBytes.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/IsoDep.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getHistoricalBytes - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| histBytes | `ArrayBuffer` | 返回历史二进制数据 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| IsoDep | ✔️ | | | | -| IsoDep.close | ✔️ | | | | -| IsoDep.connect | ✔️ | | | | -| IsoDep.getHistoricalBytes | ✔️ | | | | -| IsoDep.getMaxTransceiveLength | ✔️ | | | | -| IsoDep.isConnected | ✔️ | | | | -| IsoDep.setTimeout | ✔️ | | | | -| IsoDep.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/MifareClassic.md b/versioned_docs/version-4.x/apis/device/nfc/MifareClassic.md deleted file mode 100644 index 66ae50db7af9..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/MifareClassic.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: MifareClassic -sidebar_label: MifareClassic ---- - -MifareClassic 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareClassic.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MifareClassic | ✔️ | | | | -| MifareClassic.close | ✔️ | | | | -| MifareClassic.connect | ✔️ | | | | -| MifareClassic.getMaxTransceiveLength | ✔️ | | | | -| MifareClassic.isConnected | ✔️ | | | | -| MifareClassic.setTimeout | ✔️ | | | | -| MifareClassic.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/MifareUltralight.md b/versioned_docs/version-4.x/apis/device/nfc/MifareUltralight.md deleted file mode 100644 index 809e19541f17..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/MifareUltralight.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: MifareUltralight -sidebar_label: MifareUltralight ---- - -MifareUltralight 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/MifareUltralight.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MifareUltralight | ✔️ | | | | -| MifareUltralight.close | ✔️ | | | | -| MifareUltralight.connect | ✔️ | | | | -| MifareUltralight.getMaxTransceiveLength | ✔️ | | | | -| MifareUltralight.isConnected | ✔️ | | | | -| MifareUltralight.setTimeout | ✔️ | | | | -| MifareUltralight.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/NFCAdapter.md b/versioned_docs/version-4.x/apis/device/nfc/NFCAdapter.md deleted file mode 100644 index 939add26e157..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/NFCAdapter.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -title: NFCAdapter -sidebar_label: NFCAdapter ---- - -NFC 实例 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.html) - -## 方法 - -### getIsoDep - -获取IsoDep实例，实例支持ISO-DEP (ISO 14443-4)标准的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getIsoDep.html) - -```tsx -() => IsoDep -``` - -### getMifareClassic - -获取MifareClassic实例，实例支持MIFARE Classic标签的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getMifareClassic.html) - -```tsx -() => MifareClassic -``` - -### getMifareUltralight - -获取MifareUltralight实例，实例支持MIFARE Ultralight标签的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getMifareUltralight.html) - -```tsx -() => MifareUltralight -``` - -### getNdef - -获取Ndef实例，实例支持对NDEF格式的NFC标签上的NDEF数据的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getNdef.html) - -```tsx -() => Ndef -``` - -### getNfcA - -获取NfcA实例，实例支持NFC-A (ISO 14443-3A)标准的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getNfcA.html) - -```tsx -() => NfcA -``` - -### getNfcB - -获取NfcB实例，实例支持NFC-B (ISO 14443-3B)标准的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getNfcB.html) - -```tsx -() => NfcB -``` - -### getNfcF - -获取NfcF实例，实例支持NFC-F (JIS 6319-4)标准的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getNfcF.html) - -```tsx -() => NfcB -``` - -### getNfcV - -获取NfcV实例，实例支持NFC-V (ISO 15693)标准的读写 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.getNfcV.html) - -```tsx -() => NfcV -``` - -### offDiscovered - -取消监听 NFC Tag - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.offDiscovered.html) - -```tsx -(callback?: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听 NFC Tag的回调函数 | - -### onDiscovered - -监听 NFC Tag - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.onDiscovered.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听 NFC Tag的回调函数 | - -### startDiscovery - -开始扫描NFC标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.startDiscovery.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### stopDiscovery - -关闭NFC标签扫描 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NFCAdapter.stopDiscovery.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### onDiscovered - -#### Callback - -监听 NFC Tag的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| techs | `string[]` | 是 | tech 数组，用于匹配NFC卡片具体可以使用什么标准（NfcA等实例）处理 | -| messages | `NdefMessage[]` | 是 | NdefMessage 数组，消息格式为 {id: ArrayBuffer, type: ArrayBuffer, payload: ArrayBuffer} | -| id | `ArrayBuffer` | 否 | NFC标签的UID
API 支持度: tt | - -#### NdefMessage - -| 参数 | 类型 | -| --- | --- | -| id | `ArrayBuffer` | -| type | `ArrayBuffer` | -| payload | `ArrayBuffer` | - -### startDiscovery - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### stopDiscovery - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| NFCAdapter | ✔️ | | | | | -| NFCAdapter.getIsoDep | ✔️ | | | | | -| NFCAdapter.getMifareClassic | ✔️ | ✔️ | | | | -| NFCAdapter.getMifareUltralight | ✔️ | | | | | -| NFCAdapter.getNdef | ✔️ | | | | | -| NFCAdapter.getNfcA | ✔️ | ✔️ | | | | -| NFCAdapter.getNfcB | ✔️ | | | | | -| NFCAdapter.getNfcF | ✔️ | | | | | -| NFCAdapter.getNfcV | ✔️ | | | | | -| NFCAdapter.offDiscovered | ✔️ | ✔️ | | | | -| NFCAdapter.onDiscovered | ✔️ | ✔️ | | | | -| NFCAdapter.startDiscovery | ✔️ | ✔️ | | | | -| NFCAdapter.stopDiscovery | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/Ndef.md b/versioned_docs/version-4.x/apis/device/nfc/Ndef.md deleted file mode 100644 index 1ef553808207..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/Ndef.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: Ndef -sidebar_label: Ndef ---- - -Ndef 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### offNdefMessage - -取消监听 Ndef 消息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.offNdefMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听 Ndef 消息回调函数 | - -### onNdefMessage - -监听 Ndef 消息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.onNdefMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听 Ndef 消息回调函数 | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### writeNdefMessage - -重写 Ndef 标签内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/Ndef.writeNdefMessage.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### onNdefMessage - -#### Callback - -监听 Ndef 消息回调函数 - -```tsx -(args: unknown[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `unknown[]` | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### writeNdefMessage - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| uris | `string[]` | 否 | uri 数组 | -| texts | `string[]` | 否 | text 数组 | -| records | `record[]` | 否 | 二进制对象数组, 需要指明 id, type 以及 payload (均为 ArrayBuffer 类型) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -#### record - -| 参数 | 类型 | -| --- | --- | -| id | `ArrayBuffer` | -| type | `ArrayBuffer` | -| payload | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Ndef | ✔️ | | | | -| Ndef.close | ✔️ | | | | -| Ndef.connect | ✔️ | | | | -| Ndef.isConnected | ✔️ | | | | -| Ndef.offNdefMessage | ✔️ | | | | -| Ndef.onNdefMessage | ✔️ | | | | -| Ndef.setTimeout | ✔️ | | | | -| Ndef.writeNdefMessage | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/NfcA.md b/versioned_docs/version-4.x/apis/device/nfc/NfcA.md deleted file mode 100644 index 2df956d0246b..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/NfcA.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -title: NfcA -sidebar_label: NfcA ---- - -NfcA 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getAtqa - -获取 ATQA 信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.getAtqa.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getSak - -获取 SAK 信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.getSak.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcA.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getAtqa - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| atqa | `ArrayBuffer` | 返回 ATQA/SENS_RES 数据 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### getSak - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sak | `number` | 返回 SAK/SEL_RES 数据 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| NfcA | ✔️ | ✔️ | | | | -| NfcA.close | ✔️ | ✔️ | | | | -| NfcA.connect | ✔️ | ✔️ | | | | -| NfcA.getAtqa | ✔️ | ✔️ | | | | -| NfcA.getMaxTransceiveLength | ✔️ | ✔️ | | | | -| NfcA.getSak | ✔️ | ✔️ | | | | -| NfcA.isConnected | ✔️ | ✔️ | | | | -| NfcA.setTimeout | ✔️ | ✔️ | | | | -| NfcA.transceive | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/NfcB.md b/versioned_docs/version-4.x/apis/device/nfc/NfcB.md deleted file mode 100644 index 6d2d8bc820e4..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/NfcB.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: NfcB -sidebar_label: NfcB ---- - -NfcB 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcB.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| NfcB | ✔️ | | | | -| NfcB.close | ✔️ | | | | -| NfcB.connect | ✔️ | | | | -| NfcB.getMaxTransceiveLength | ✔️ | | | | -| NfcB.isConnected | ✔️ | | | | -| NfcB.setTimeout | ✔️ | | | | -| NfcB.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/NfcF.md b/versioned_docs/version-4.x/apis/device/nfc/NfcF.md deleted file mode 100644 index 4e869f6527a9..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/NfcF.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: NfcF -sidebar_label: NfcF ---- - -NfcF 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcF.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| NfcF | ✔️ | | | | -| NfcF.close | ✔️ | | | | -| NfcF.connect | ✔️ | | | | -| NfcF.getMaxTransceiveLength | ✔️ | | | | -| NfcF.isConnected | ✔️ | | | | -| NfcF.setTimeout | ✔️ | | | | -| NfcF.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/NfcV.md b/versioned_docs/version-4.x/apis/device/nfc/NfcV.md deleted file mode 100644 index 0523bf4cf6f0..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/NfcV.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: NfcV -sidebar_label: NfcV ---- - -NfcV 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.html) - -## 方法 - -### close - -断开连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.close.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### connect - -连接 NFC 标签 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.connect.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### getMaxTransceiveLength - -获取最大传输长度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.getMaxTransceiveLength.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### isConnected - -检查是否已连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.isConnected.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### setTimeout - -设置超时时间 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.setTimeout.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### transceive - -发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/NfcV.transceive.html) - -```tsx -(option?: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### close - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### connect - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### getMaxTransceiveLength - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| length | `number` | 最大传输长度 | - -### isConnected - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### setTimeout - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeout | `number` | 是 | 设置超时时间 (ms) | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -### transceive - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 需要传递的二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| data | `ArrayBuffer` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| NfcV | ✔️ | | | | -| NfcV.close | ✔️ | | | | -| NfcV.connect | ✔️ | | | | -| NfcV.getMaxTransceiveLength | ✔️ | | | | -| NfcV.isConnected | ✔️ | | | | -| NfcV.setTimeout | ✔️ | | | | -| NfcV.transceive | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/device/nfc/getHCEState.md b/versioned_docs/version-4.x/apis/device/nfc/getHCEState.md deleted file mode 100644 index eab8f27fd7cc..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/getHCEState.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.getHCEState(option) -sidebar_label: getHCEState ---- - -判断当前设备是否支持 HCE 能力。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.getHCEState.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.getHCEState({ - success: function (res) { - console.log(res.errCode) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/nfc/getNFCAdapter.md b/versioned_docs/version-4.x/apis/device/nfc/getNFCAdapter.md deleted file mode 100644 index 2bbc2b5b4d5c..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/getNFCAdapter.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.getNFCAdapter() -sidebar_label: getNFCAdapter ---- - -获取 NFC 实例 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.getNFCAdapter.html) - -## 类型 - -```tsx -() => NFCAdapter -``` diff --git a/versioned_docs/version-4.x/apis/device/nfc/offHCEMessage.md b/versioned_docs/version-4.x/apis/device/nfc/offHCEMessage.md deleted file mode 100644 index 020fc9096710..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/offHCEMessage.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offHCEMessage(callback) -sidebar_label: offHCEMessage ---- - -接收 NFC 设备消息事件，取消事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.offHCEMessage.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 接收 NFC 设备消息事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/nfc/onHCEMessage.md b/versioned_docs/version-4.x/apis/device/nfc/onHCEMessage.md deleted file mode 100644 index 278440160518..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/onHCEMessage.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.onHCEMessage(callback) -sidebar_label: onHCEMessage ---- - -监听接收 NFC 设备消息事件，仅能注册一个监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.onHCEMessage.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 接收 NFC 设备消息事件的回调函数 | - -### Callback - -接收 NFC 设备消息事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `ArrayBuffer` | `messageType=1` 时 ,客户端接收到 NFC 设备的指令 | -| messageType | `keyof MessageType` | 消息类型 | -| reason | `number` | `messageType=2` 时，原因 | - -### MessageType - -消息类型 - -| 参数 | 说明 | -| --- | --- | -| 1 | HCE APDU Command类型，小程序需对此指令进行处理，并调用 sendHCEMessage 接口返回处理指令 | -| 2 | 设备离场事件类型 | diff --git a/versioned_docs/version-4.x/apis/device/nfc/sendHCEMessage.md b/versioned_docs/version-4.x/apis/device/nfc/sendHCEMessage.md deleted file mode 100644 index e1d994e96ccb..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/sendHCEMessage.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.sendHCEMessage(option) -sidebar_label: sendHCEMessage ---- - -发送 NFC 消息。仅在安卓系统下有效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.sendHCEMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `ArrayBuffer` | 是 | 二进制数据 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -const buffer = new ArrayBuffer(1) -const dataView = new DataView(buffer) -dataView.setUint8(0, 0) - Taro.startHCE({ - success: function (res) { - Taro.onHCEMessage(function (res) { - if (res.messageType === 1) { - Taro.sendHCEMessage({data: buffer}) - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/nfc/startHCE.md b/versioned_docs/version-4.x/apis/device/nfc/startHCE.md deleted file mode 100644 index 64726dc12925..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/startHCE.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.startHCE(option) -sidebar_label: startHCE ---- - -初始化 NFC 模块。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.startHCE.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| aid_list | `string[]` | 是 | 需要注册到系统的 AID 列表 | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startHCE({ - aid_list: ['F222222222'] - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/nfc/stopHCE.md b/versioned_docs/version-4.x/apis/device/nfc/stopHCE.md deleted file mode 100644 index 67dfc6961aac..000000000000 --- a/versioned_docs/version-4.x/apis/device/nfc/stopHCE.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.stopHCE(option) -sidebar_label: stopHCE ---- - -关闭 NFC 模块。仅在安卓系统下有效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.stopHCE.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.NFCError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopHCE({ - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/phone/makePhoneCall.md b/versioned_docs/version-4.x/apis/device/phone/makePhoneCall.md deleted file mode 100644 index 936f4d208bf2..000000000000 --- a/versioned_docs/version-4.x/apis/device/phone/makePhoneCall.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.makePhoneCall(option) -sidebar_label: makePhoneCall ---- - -拨打电话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/phone/wx.makePhoneCall.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| phoneNumber | `string` | 是 | 需要拨打的电话号码 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.makePhoneCall({ - phoneNumber: '1340000' //仅为示例，并非真实的电话号码 -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/scan/scanCode.md b/versioned_docs/version-4.x/apis/device/scan/scanCode.md deleted file mode 100644 index f6a2a522a0cc..000000000000 --- a/versioned_docs/version-4.x/apis/device/scan/scanCode.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Taro.scanCode(option) -sidebar_label: scanCode ---- - -调起客户端扫码界面，扫码成功后返回对应的结果 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/scan/wx.scanCode.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| onlyFromCamera | `boolean` | `false` | 否 | 是否只能从相机扫码，不允许从相册选择图片 | -| scanType | `(keyof ScanType)[]` | | 否 | 扫码类型 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| charSet | `string` | 所扫码的字符集 | -| path | `string` | 当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path | -| rawData | `string` | 原始数据，base64编码 | -| result | `string` | 所扫码的内容 | -| scanType | `keyof QRType` | 所扫码的类型 | -| errMsg | `string` | 调用结果 | - -### ScanType - -扫码类型 - -| 参数 | 说明 | -| --- | --- | -| barCode | 一维码 | -| qrCode | 二维码 | -| datamatrix | Data Matrix 码 | -| pdf417 | PDF417 条码 | - -### QRType - -所扫码的类型 - -| 参数 | 说明 | -| --- | --- | -| QR_CODE | 二维码 | -| AZTEC | 一维码 | -| CODABAR | 一维码 | -| CODE_39 | 一维码 | -| CODE_93 | 一维码 | -| CODE_128 | 一维码 | -| DATA_MATRIX | 二维码 | -| EAN_8 | 一维码 | -| EAN_13 | 一维码 | -| ITF | 一维码 | -| MAXICODE | 一维码 | -| PDF_417 | 二维码 | -| RSS_14 | 一维码 | -| RSS_EXPANDED | 一维码 | -| UPC_A | 一维码 | -| UPC_E | 一维码 | -| UPC_EAN_EXTENSION | 一维码 | -| WX_CODE | 二维码 | -| CODE_25 | 一维码 | - -## 示例代码 - -```tsx -// 允许从相机和相册扫码 -Taro.scanCode({ - success: (res) => { - console.log(res) - } -}) -// 只允许从相机扫码 -Taro.scanCode({ - onlyFromCamera: true, - success: (res) => { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/getScreenBrightness.md b/versioned_docs/version-4.x/apis/device/screen/getScreenBrightness.md deleted file mode 100644 index d8296c253e98..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/getScreenBrightness.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.getScreenBrightness(option) -sidebar_label: getScreenBrightness ---- - -获取屏幕亮度。 - -**说明** -- 若安卓系统设置中开启了自动调节亮度功能，则屏幕亮度会根据光线自动调整，该接口仅能获取自动调节亮度之前的值，而非实时的亮度值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenBrightness.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(option: SuccessCallbackOption) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | `number` | 屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮 | diff --git a/versioned_docs/version-4.x/apis/device/screen/getScreenRecordingState.md b/versioned_docs/version-4.x/apis/device/screen/getScreenRecordingState.md deleted file mode 100644 index 7eada594694e..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/getScreenRecordingState.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.getScreenRecordingState(option) -sidebar_label: getScreenRecordingState ---- - -查询用户是否在录屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenRecordingState.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(option: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ScreenRecordingState - -| 参数 | 说明 | -| --- | --- | -| on | 开启 | -| off | 关闭 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| state | `keyof ScreenRecordingState` | 录屏状态 | - -## 示例代码 - -```tsx -Taro.getScreenRecordingState({ - success: function (res) { - console.log(res.state) - }, -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/offScreenRecordingStateChanged.md b/versioned_docs/version-4.x/apis/device/screen/offScreenRecordingStateChanged.md deleted file mode 100644 index 8a9753fd21b3..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/offScreenRecordingStateChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offScreenRecordingStateChanged(callback) -sidebar_label: offScreenRecordingStateChanged ---- - -取消用户录屏事件的监听函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offScreenRecordingStateChanged.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户录屏事件的监听函数 | diff --git a/versioned_docs/version-4.x/apis/device/screen/offUserCaptureScreen.md b/versioned_docs/version-4.x/apis/device/screen/offUserCaptureScreen.md deleted file mode 100644 index 03f1e3b40990..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/offUserCaptureScreen.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offUserCaptureScreen(callback) -sidebar_label: offUserCaptureScreen ---- - -用户主动截屏事件。取消事件监听。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户主动截屏事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/screen/onScreenRecordingStateChanged.md b/versioned_docs/version-4.x/apis/device/screen/onScreenRecordingStateChanged.md deleted file mode 100644 index 2c09769e6cc9..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/onScreenRecordingStateChanged.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.onScreenRecordingStateChanged(callback) -sidebar_label: onScreenRecordingStateChanged ---- - -监听用户录屏事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.onScreenRecordingStateChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户录屏事件的监听函数 | - -### ScreenRecordingState - -| 参数 | 说明 | -| --- | --- | -| start | 开始录屏 | -| stop | 结束录屏 | - -### Callback - -用户录屏事件的监听函数 - -```tsx -(state: keyof ScreenRecordingState) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| state | `keyof ScreenRecordingState` | 录屏状态 | - -## 示例代码 - -```tsx -// 监听用户录屏事件 -const handler = function (res) { - console.log(res.state) -} -Taro.onScreenRecordingStateChanged(handler) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/onUserCaptureScreen.md b/versioned_docs/version-4.x/apis/device/screen/onUserCaptureScreen.md deleted file mode 100644 index 42734737f6bd..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/onUserCaptureScreen.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onUserCaptureScreen(callback) -sidebar_label: onUserCaptureScreen ---- - -监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.onUserCaptureScreen.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户主动截屏事件的回调函数 | - -### Callback - -用户主动截屏事件的回调函数 - -```tsx -(result: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `TaroGeneral.CallbackResult` | - -## 示例代码 - -```tsx -Taro.onUserCaptureScreen(function (res) { - console.log('用户截屏了') -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/setKeepScreenOn.md b/versioned_docs/version-4.x/apis/device/screen/setKeepScreenOn.md deleted file mode 100644 index c2ce451e7fc9..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/setKeepScreenOn.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.setKeepScreenOn(option) -sidebar_label: setKeepScreenOn ---- - -设置是否保持常亮状态。仅在当前小程序生效，离开小程序后设置失效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setKeepScreenOn.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 调用结果 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| keepScreenOn | `boolean` | 是 | 是否保持屏幕常亮 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -// 保持屏幕常亮 -Taro.setKeepScreenOn({ - keepScreenOn: true -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/setScreenBrightness.md b/versioned_docs/version-4.x/apis/device/screen/setScreenBrightness.md deleted file mode 100644 index 1f2ff2d613ba..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/setScreenBrightness.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.setScreenBrightness(option) -sidebar_label: setScreenBrightness ---- - -设置屏幕亮度。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setScreenBrightness.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| value | `number` | 是 | 屏幕亮度值，范围 0 ~ 1。0 最暗，1 最亮 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setScreenBrightness(params).then(...) -``` diff --git a/versioned_docs/version-4.x/apis/device/screen/setVisualEffectOnCapture.md b/versioned_docs/version-4.x/apis/device/screen/setVisualEffectOnCapture.md deleted file mode 100644 index 0681a743abf8..000000000000 --- a/versioned_docs/version-4.x/apis/device/screen/setVisualEffectOnCapture.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.setVisualEffectOnCapture(option) -sidebar_label: setVisualEffectOnCapture ---- - -设置截屏/录屏时屏幕表现，仅支持在 Android 端调用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setVisualEffectOnCapture.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| visualEffect | "none" or "hidden" | `"none"` | 否 | 截屏/录屏时的表现，仅支持 none / hidden，传入 hidden 则表示在截屏/录屏时隐藏屏幕 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/sms/sendSms.md b/versioned_docs/version-4.x/apis/device/sms/sendSms.md deleted file mode 100644 index 5638c06d9209..000000000000 --- a/versioned_docs/version-4.x/apis/device/sms/sendSms.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.sendSms(option) -sidebar_label: sendSms ---- - -拉起手机发送短信界面 - -支持情况： - -> [参考文档](declare module '../../index') - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| phoneNumber | `string` | 否 | 预填到发送短信面板的手机号 | -| content | `string` | 否 | 预填到发送短信面板的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/vibrate/vibrateLong.md b/versioned_docs/version-4.x/apis/device/vibrate/vibrateLong.md deleted file mode 100644 index 158e6fda6175..000000000000 --- a/versioned_docs/version-4.x/apis/device/vibrate/vibrateLong.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.vibrateLong(option) -sidebar_label: vibrateLong ---- - -使手机发生较长时间的振动（400ms） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateLong.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.vibrateLong(params).then(...) -``` diff --git a/versioned_docs/version-4.x/apis/device/vibrate/vibrateShort.md b/versioned_docs/version-4.x/apis/device/vibrate/vibrateShort.md deleted file mode 100644 index 831628dbab3a..000000000000 --- a/versioned_docs/version-4.x/apis/device/vibrate/vibrateShort.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.vibrateShort(option) -sidebar_label: vibrateShort ---- - -使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效 - -仅微信小程序平台支持 type 参数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateShort.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| type | "heavy" or "medium" or "light" | 否 | 震动强度类型，有效值为：heavy、medium、light | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.vibrateShort(params).then(...) -``` diff --git a/versioned_docs/version-4.x/apis/device/wifi/WifiInfo.md b/versioned_docs/version-4.x/apis/device/wifi/WifiInfo.md deleted file mode 100644 index 9d1db0516cc0..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/WifiInfo.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: WifiInfo -sidebar_label: WifiInfo ---- - -Wifi 信息 - -注意: -安卓 Taro.connectWifi / Taro.getConnectedWifi 若设置了 partialInfo:true ，或者调用了 Taro.onWifiConnectedWithPartialInfo 事件。将会返回只包含 SSID 属性的 WifiInfo 对象。 在某些情况下，可能 Wi-Fi 已经连接成功，但会因为获取不到完整的 WifiInfo 对象报错。具体错误信息为 errCode: 12010, errMsg: can't gain current wifi 。如果开发者不需要完整的 WifiInfo 对象，则可以通过采取上述策略解决报错问题。 - -## 方法 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| SSID | `string` | 是 | Wi-Fi 的 SSID | -| BSSID | `string` | 是 | Wi-Fi 的 BSSID | -| secure | `boolean` | 是 | Wi-Fi 是否安全 | -| signalStrength | `number` | 是 | Wi-Fi 信号强度, 安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1 ，值越大强度越大 | -| frequency | `number` | 否 | Wi-Fi 频段单位 MHz | diff --git a/versioned_docs/version-4.x/apis/device/wifi/connectWifi.md b/versioned_docs/version-4.x/apis/device/wifi/connectWifi.md deleted file mode 100644 index 3798e96f0aa8..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/connectWifi.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.connectWifi(option) -sidebar_label: connectWifi ---- - -连接 Wi-Fi。若已知 Wi-Fi 信息，可以直接利用该接口连接。仅 Android 与 iOS 11 以上版本支持。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.connectWifi.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| SSID | `string` | | 是 | Wi-Fi 设备 SSID | -| password | `string` | | 是 | Wi-Fi 设备密码 | -| BSSID | `string` | | 否 | Wi-Fi 设备 BSSID | -| maunal | `boolean` | `false` | 否 | 跳转到系统设置页进行连接 | -| partialInfo | `boolean` | `false` | 否 | 是否需要返回部分 Wi-Fi 信息，仅安卓生效 | -| complete | `(res: TaroGeneral.WifiError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.WifiError) => void` | | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.connectWifi({ - SSID: '', - BSSID: '', - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/wifi/getConnectedWifi.md b/versioned_docs/version-4.x/apis/device/wifi/getConnectedWifi.md deleted file mode 100644 index ab9dec246945..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/getConnectedWifi.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.getConnectedWifi(option) -sidebar_label: getConnectedWifi ---- - -获取已连接中的 Wi-Fi 信息。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getConnectedWifi.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| partialInfo | `boolean` | `false` | 否 | 是否需要返回部分 Wi-Fi 信息 | -| complete | `(res: TaroGeneral.WifiError) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| wifi | `WifiInfo` | Wi-Fi 信息 | -| errMsg | `string` | 调用结果 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/getWifiList.md b/versioned_docs/version-4.x/apis/device/wifi/getWifiList.md deleted file mode 100644 index fa1c22c0710d..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/getWifiList.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.getWifiList(option) -sidebar_label: getWifiList ---- - -请求获取 Wi-Fi 列表。在 `onGetWifiList` 注册的回调中返回 `wifiList` 数据。 **Android 调用前需要 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.userLocation。** - -iOS 将跳转到系统的 Wi-Fi 界面，Android 不会跳转。 iOS 11.0 及 iOS 11.1 两个版本因系统问题，该方法失效。但在 iOS 11.2 中已修复。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getWifiList.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/offGetWifiList.md b/versioned_docs/version-4.x/apis/device/wifi/offGetWifiList.md deleted file mode 100644 index 6d1062eddc5c..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/offGetWifiList.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offGetWifiList(callback) -sidebar_label: offGetWifiList ---- - -取消监听获取到 Wi-Fi 列表数据事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offGetWifiList.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 获取到 Wi-Fi 列表数据事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/offWifiConnected.md b/versioned_docs/version-4.x/apis/device/wifi/offWifiConnected.md deleted file mode 100644 index ecbdfb2d834e..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/offWifiConnected.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offWifiConnected(callback) -sidebar_label: offWifiConnected ---- - -取消监听连接上 Wi-Fi 的事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offWifiConnected.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 连接上 Wi-Fi 的事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/offWifiConnectedWithPartialInfo.md b/versioned_docs/version-4.x/apis/device/wifi/offWifiConnectedWithPartialInfo.md deleted file mode 100644 index 0039bdda2df3..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/offWifiConnectedWithPartialInfo.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offWifiConnectedWithPartialInfo(callback) -sidebar_label: offWifiConnectedWithPartialInfo ---- - -取消监听连接上 Wi-Fi 的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offWifiConnectedWithPartialInfo.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 连接上 Wi-Fi 的事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/onGetWifiList.md b/versioned_docs/version-4.x/apis/device/wifi/onGetWifiList.md deleted file mode 100644 index 761952a01b30..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/onGetWifiList.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.onGetWifiList(callback) -sidebar_label: onGetWifiList ---- - -监听获取到 Wi-Fi 列表数据事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onGetWifiList.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 获取到 Wi-Fi 列表数据事件的回调函数 | - -### Callback - -获取到 Wi-Fi 列表数据事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| wifiList | `WifiInfo[]` | Wi-Fi 列表数据 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/onWifiConnected.md b/versioned_docs/version-4.x/apis/device/wifi/onWifiConnected.md deleted file mode 100644 index 69720f81e1e7..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/onWifiConnected.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.onWifiConnected(callback) -sidebar_label: onWifiConnected ---- - -监听连接上 Wi-Fi 的事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnected.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 连接上 Wi-Fi 的事件的回调函数 | - -### Callback - -连接上 Wi-Fi 的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| wifi | `WifiInfo` | Wi-Fi 信息 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/onWifiConnectedWithPartialInfo.md b/versioned_docs/version-4.x/apis/device/wifi/onWifiConnectedWithPartialInfo.md deleted file mode 100644 index 11c86b30a891..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/onWifiConnectedWithPartialInfo.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.onWifiConnectedWithPartialInfo(callback) -sidebar_label: onWifiConnectedWithPartialInfo ---- - -监听连接上 Wi-Fi 的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnectedWithPartialInfo.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 连接上 Wi-Fi 的事件的回调函数 | - -### Callback - -连接上 Wi-Fi 的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| wifi | `Pick` | 只包含 SSID 属性的 WifiInfo 对象 | diff --git a/versioned_docs/version-4.x/apis/device/wifi/setWifiList.md b/versioned_docs/version-4.x/apis/device/wifi/setWifiList.md deleted file mode 100644 index 515dda3bae6f..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/setWifiList.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Taro.setWifiList(option) -sidebar_label: setWifiList ---- - -设置 `wifiList` 中 AP 的相关信息。在 `onGetWifiList` 回调后调用，**iOS特有接口**。 - -**注意** -- 该接口只能在 `onGetWifiList` 回调之后才能调用。 -- 此时客户端会挂起，等待小程序设置 Wi-Fi 信息，请务必尽快调用该接口，若无数据请传入一个空数组。 -- 有可能随着周边 Wi-Fi 列表的刷新，单个流程内收到多次带有存在重复的 Wi-Fi 列表的回调。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.setWifiList.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| wifiList | `WifiData[]` | 是 | 提供预设的 Wi-Fi 信息列表 | -| complete | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用成功的回调函数 | - -### WifiData - -提供预设的 Wi-Fi 信息列表 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| BSSID | `string` | 否 | Wi-Fi 的 BSSID | -| SSID | `string` | 否 | Wi-Fi 的 SSID | -| password | `string` | 否 | Wi-Fi 设备密码 | - -## 示例代码 - -```tsx -Taro.onGetWifiList(function (res) { - if (res.wifiList.length) { - Taro.setWifiList({ - wifiList: [{ - SSID: res.wifiList[0].SSID, - BSSID: res.wifiList[0].BSSID, - password: '123456' - }] - }) - } else { - Taro.setWifiList({ - wifiList: [] - }) - } -}) -Taro.getWifiList() -``` diff --git a/versioned_docs/version-4.x/apis/device/wifi/startWifi.md b/versioned_docs/version-4.x/apis/device/wifi/startWifi.md deleted file mode 100644 index 8bb8e0cbea27..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/startWifi.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.startWifi(option) -sidebar_label: startWifi ---- - -初始化 Wi-Fi 模块。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.startWifi.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startWifi({ - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/device/wifi/stopWifi.md b/versioned_docs/version-4.x/apis/device/wifi/stopWifi.md deleted file mode 100644 index d86084c7e6a0..000000000000 --- a/versioned_docs/version-4.x/apis/device/wifi/stopWifi.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.stopWifi(option) -sidebar_label: stopWifi ---- - -关闭 Wi-Fi 模块。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.stopWifi.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.WifiError) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopWifi({ - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/ext/getExtConfig.md b/versioned_docs/version-4.x/apis/ext/getExtConfig.md deleted file mode 100644 index 409fef7026e5..000000000000 --- a/versioned_docs/version-4.x/apis/ext/getExtConfig.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Taro.getExtConfig(option) -sidebar_label: getExtConfig ---- - -获取[第三方平台](https://developers.weixin.qq.com/miniprogram/dev/devtools/ext.html)自定义的数据字段。 - -**Tips** -1. 本接口暂时无法通过 Taro.canIUse 判断是否兼容，开发者需要自行判断 Taro.getExtConfig 是否存在来兼容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ext/wx.getExtConfig.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| extConfig | `TaroGeneral.IAnyObject` | 第三方平台自定义的数据 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -if(Taro.getExtConfig) { - Taro.getExtConfig({ - success: function (res) { - console.log(res.extConfig) - } - }) -} -``` diff --git a/versioned_docs/version-4.x/apis/ext/getExtConfigSync.md b/versioned_docs/version-4.x/apis/ext/getExtConfigSync.md deleted file mode 100644 index 10af996057d4..000000000000 --- a/versioned_docs/version-4.x/apis/ext/getExtConfigSync.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.getExtConfigSync() -sidebar_label: getExtConfigSync ---- - -Taro.getExtConfig 的同步版本。 - -**Tips** -1. 本接口暂时无法通过 Taro.canIUse 判断是否兼容，开发者需要自行判断 Taro.getExtConfigSync 是否存在来兼容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ext/wx.getExtConfigSync.html) - -## 类型 - -```tsx -() => TaroGeneral.IAnyObject -``` - -## 参数 - -### ExtInfo - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| extConfig | `TaroGeneral.IAnyObject` | 第三方平台自定义的数据 | - -## 示例代码 - -```tsx -let extConfig = Taro.getExtConfigSync? Taro.getExtConfigSync(): {} - -console.log(extConfig) -``` diff --git a/versioned_docs/version-4.x/apis/files/FileSystemManager.md b/versioned_docs/version-4.x/apis/files/FileSystemManager.md deleted file mode 100644 index 563caf60532c..000000000000 --- a/versioned_docs/version-4.x/apis/files/FileSystemManager.md +++ /dev/null @@ -1,1440 +0,0 @@ ---- -title: FileSystemManager -sidebar_label: FileSystemManager ---- - -文件管理器，可通过 [Taro.getFileSystemManager](./getFileSystemManager) 获取。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.html) - -## 方法 - -### access - -判断文件/目录是否存在 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.access.html) - -```tsx -(option: AccessOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AccessOption` | - -### accessSync - -[FileSystemManager.access](#access) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.accessSync.html) - -```tsx -(path: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| path | `string` | 要判断是否存在的文件/目录路径 | - -### appendFile - -在文件结尾追加内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFile.html) - -```tsx -(option: AppendFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AppendFileOption` | - -### appendFileSync - -[FileSystemManager.appendFile](#appendfile) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFileSync.html) - -```tsx -(filePath: string, data: string | ArrayBuffer, encoding?: keyof Encoding) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| filePath | `string` | 要追加内容的文件路径 | -| data | string or ArrayBuffer | 要追加的文本或二进制数据 | -| encoding | `keyof Encoding` | 指定写入文件的字符编码 | - -### close - -关闭文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.close.html) - -```tsx -(option: CloseOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `CloseOption` | - -### closeSync - -[FileSystemManager.close](#close) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.closeSync.html) - -```tsx -(option: CloseSyncOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `CloseSyncOption` | - -### copyFile - -复制文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFile.html) - -```tsx -(option: CopyFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `CopyFileOption` | - -### copyFileSync - -[FileSystemManager.copyFile](#copyfile) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFileSync.html) - -```tsx -(srcPath: string, destPath: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| srcPath | `string` | 源文件路径，只可以是普通文件 | -| destPath | `string` | 目标文件路径 | - -### fstat - -获取文件的状态信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.fstat.html) - -```tsx -(option: FstatOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `FstatOption` | - -### fstatSync - -[FileSystemManager.fstat](#fstat) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.fstatSync.html) - -```tsx -(option: FstatSyncOption) => Stats -``` - -| 参数 | 类型 | -| --- | --- | -| option | `FstatSyncOption` | - -### ftruncate - -对文件内容进行截断操作 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.ftruncate.html) - -```tsx -(option: FtruncateOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `FtruncateOption` | - -### ftruncateSync - -[FileSystemManager.ftruncate](#ftruncate) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.ftruncateSync.html) - -```tsx -(option: FtruncateSyncOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `FtruncateSyncOption` | - -### getFileInfo - -获取该小程序下的 `本地临时文件` 或 `本地缓存文件` 信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getFileInfo.html) - -```tsx -(option: getFileInfoOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `getFileInfoOption` | - -### getSavedFileList - -获取该小程序下已保存的本地缓存文件列表 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getSavedFileList.html) - -```tsx -(option?: getSavedFileListOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `getSavedFileListOption` | - -### mkdir - -创建目录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdir.html) - -```tsx -(option: MkdirOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `MkdirOption` | - -### mkdirSync - -[FileSystemManager.mkdir](#mkdir) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdirSync.html) - -```tsx -(dirPath: string, recursive?: boolean) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| dirPath | `string` | 创建的目录路径 | -| recursive | `boolean` | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 | - -### open - -打开文件，返回文件描述符 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.open.html) - -```tsx -(option: OpenOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `OpenOption` | - -### openSync - -[FileSystemManager.openSync](#opensync) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.ftruncateSync.html) - -```tsx -(option: OpenSyncOption) => string -``` - -| 参数 | 类型 | -| --- | --- | -| option | `OpenSyncOption` | - -### read - -读文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.read.html) - -```tsx -(option: ReadOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ReadOption` | - -### readCompressedFile - -读取指定压缩类型的本地文件内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readCompressedFile.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### readCompressedFileSync - -同步读取指定压缩类型的本地文件内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readCompressedFileSync.html) - -```tsx -(option: Option) => ArrayBuffer -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### readdir - -读取目录内文件列表 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdir.html) - -```tsx -(option: ReaddirOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ReaddirOption` | - -### readdirSync - -[FileSystemManager.readdir](#readdir) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdirSync.html) - -```tsx -(dirPath: string) => string[] -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| dirPath | `string` | 要读取的目录路径 | - -### readFile - -读取本地文件内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFile.html) - -```tsx -(option: ReadFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ReadFileOption` | - -### readFileSync - -[FileSystemManager.readFile](#readfile) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFileSync.html) - -```tsx -(filePath: string, encoding?: keyof Encoding, position?: number, length?: number) => string | ArrayBuffer -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| filePath | `string` | 要读取的文件的路径 | -| encoding | `keyof Encoding` | 指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容 | -| position | `number` | 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte | -| length | `number` | 指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte | - -### readSync - -[FileSystemManager.read](#read) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readSync.html) - -```tsx -(option: ReadSyncOption) => { bytesRead: number; arrayBuffer: ArrayBuffer; } -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ReadSyncOption` | - -### readZipEntry - -读取压缩包内的文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readZipEntry.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### removeSavedFile - -删除该小程序下已保存的本地缓存文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.removeSavedFile.html) - -```tsx -(option: RemoveSavedFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveSavedFileOption` | - -### rename - -重命名文件。可以把文件从 oldPath 移动到 newPath - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rename.html) - -```tsx -(option: RenameOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RenameOption` | - -### renameSync - -[FileSystemManager.rename](#rename) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.renameSync.html) - -```tsx -(oldPath: string, newPath: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| oldPath | `string` | 源文件路径，可以是普通文件或目录 | -| newPath | `string` | 新文件路径 | - -### rmdir - -删除目录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rmdir.html) - -```tsx -(option: RmdirOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RmdirOption` | - -### rmdirSync - -[FileSystemManager.rmdir](#rmdir) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rmdirSync.html) - -```tsx -(dirPath: string, recursive?: boolean) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| dirPath | `string` | 要删除的目录路径 | -| recursive | `boolean` | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 | - -### saveFile - -保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFile.html) - -```tsx -(option: SaveFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SaveFileOption` | - -### saveFileSync - -[FileSystemManager.saveFile](#savefile) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFileSync.html) - -```tsx -(tempFilePath: string, filePath?: string) => string -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 临时存储文件路径 | -| filePath | `string` | 要存储的文件路径 | - -### stat - -获取文件 Stats 对象 - -支持情况： - -```tsx -(option: StatOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StatOption` | - -### statSync - -[FileSystemManager.stat](#stat) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.statSync.html) - -```tsx -(path: string, recursive?: boolean) => any -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| path | `string` | 文件/目录路径 | -| recursive | `boolean` | 是否递归获取目录下的每个文件的 Stats 信息 | - -### truncate - -对文件内容进行截断操作 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncate.html) - -```tsx -(option: TruncateOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `TruncateOption` | - -### truncateSync - -对文件内容进行截断操作 ([truncate](#truncate) 的同步版本) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncateSync.html) - -```tsx -(option: TruncateSyncOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `TruncateSyncOption` | - -### unlink - -删除文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlink.html) - -```tsx -(option: UnlinkOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `UnlinkOption` | - -### unlinkSync - -[FileSystemManager.unlink](#unlink) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlinkSync.html) - -```tsx -(filePath: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| filePath | `string` | 要删除的文件路径 | - -### unzip - -解压文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unzip.html) - -```tsx -(option: UnzipOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `UnzipOption` | - -### write - -写入文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.write.html) - -```tsx -(option: WriteOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `WriteOption` | - -### writeFile - -写文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFile.html) - -```tsx -(option: WriteFileOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `WriteFileOption` | - -### writeFileSync - -[FileSystemManager.writeFile](#writefile) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFileSync.html) - -```tsx -(filePath: string, data: string | ArrayBuffer, encoding?: keyof Encoding) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| filePath | `string` | 要写入的文件路径 | -| data | string or ArrayBuffer | 要写入的文本或二进制数据 | -| encoding | `keyof Encoding` | 指定写入文件的字符编码 | - -### writeSync - -[write](#write) 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeSync.html) - -```tsx -(option: WriteSyncOption) => { bytesWritten: number; } -``` - -| 参数 | 类型 | -| --- | --- | -| option | `WriteSyncOption` | - -## 参数 - -### Encoding - -字符编码 - -| 参数 | 说明 | -| --- | --- | -| ascii | | -| base64 | | -| binary | | -| hex | | -| ucs2 | 以小端序读取 | -| ucs-2 | 以小端序读取 | -| utf16le | 以小端序读取 | -| utf-16le | 以小端序读取 | -| utf-8 | | -| utf8 | | -| latin1 | | - -### flag - -文件系统标志 - -### AccessOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 要判断是否存在的文件/目录路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: AccessFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AccessFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory ${path}': 文件/目录不存在; | - -### AppendFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | string or ArrayBuffer | 是 | 要追加的文本或二进制数据 | -| filePath | `string` | 是 | 要追加内容的文件路径 | -| encoding | `keyof Encoding` | 否 | 指定写入文件的字符编码 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: AppendFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AppendFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 文件不存在;
- 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- 'fail sdcard not mounted': 指定的 filePath 是一个已经存在的目录; | - -### CopyFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| destPath | `string` | 是 | 目标文件路径 | -| srcPath | `string` | 是 | 源文件路径，只可以是普通文件 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: CopyFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CopyFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail permission denied, copyFile ${srcPath} -> ${destPath}': 指定目标文件路径没有写权限;
- 'fail no such file or directory, copyFile ${srcPath} -> ${destPath}': 源文件不存在，或目标文件路径的上层目录不存在;
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足; | - -### getFileInfoOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| filePath | `string` | | 是 | 要读取的文件路径 | -| digestAlgorithm | "md5" or "sha1" | `'md5'` | 否 | 计算文件摘要的算法 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: GetFileInfoFailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: GetFileInfoSuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### GetFileInfoFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail file not exist': 指定的 filePath 找不到文件; | - -### GetFileInfoSuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| size | `number` | 是 | 文件大小，以字节为单位 | -| digest | `string` | 否 | 按照传入的 digestAlgorithm 计算得出的的文件摘要 | -| errMsg | `string` | 是 | 调用结果 | - -### getSavedFileListOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetSavedFileListSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetSavedFileListSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileList | `GetSavedFileListSuccessCallbackResultFileItem[]` | 文件数组 | -| errMsg | `string` | 调用结果 | - -### GetSavedFileListSuccessCallbackResultFileItem - -文件数组 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| createTime | `number` | 文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数 | -| filePath | `string` | 本地路径 | -| size | `number` | 本地文件大小，以字节为单位 | - -### MkdirOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| dirPath | `string` | | 是 | 创建的目录路径 | -| recursive | `boolean` | `false` | 否 | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。
如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: MkdirFailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### MkdirFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory ${dirPath}': 上级目录不存在;
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- 'fail file already exists ${dirPath}': 有同名文件或目录; | - -### ReadFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要读取的文件的路径 | -| position | `number` | 否 | 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte | -| length | `number` | 否 | 指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| encoding | `keyof Encoding` | 否 | 指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容 | -| fail | `(result: ReadFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: ReadFileSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ReadFileSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | string or ArrayBuffer | 文件内容 | -| errMsg | `string` | 调用结果 | - -### ReadFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限; | - -### ReaddirOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| dirPath | `string` | 是 | 要读取的目录路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: ReaddirFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: ReaddirSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ReaddirFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory ${dirPath}': 目录不存在;
- 'fail not a directory ${dirPath}': dirPath 不是目录;
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限; | - -### ReaddirSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| files | `string[]` | 指定目录下的文件名数组。 | -| errMsg | `string` | 调用结果 | - -### readZipEntry - -#### Promised - -```tsx -FailCallbackResult | SuccessCallbackResult -``` - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要读取的压缩包的路径 (本地路径) | -| encoding | `string` | 否 | 统一指定读取文件的字符编码，只在 entries 值为"all"时有效。如果 entries 值为"all"且不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容 | -| entries | File[] or "all" | 是 | 要读取的压缩包内的文件列表（当传入"all" 时表示读取压缩包内所有文件） | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### File - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 压缩包内文件路径 | -| encoding | `string` | 否 | 指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容 | -| position | `number` | 否 | 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte | -| length | `number` | 否 | 指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte | - -#### Encoding - -字符编码合法值 - -| 参数 | 异常情况 | -| --- | :---: | -| ascii | | -| base64 | | -| binary | | -| hex | | -| ucs2 | `以小端序读取` | -| ucs-2 | `以小端序读取` | -| utf16le | `以小端序读取` | -| utf-16le | `以小端序读取` | -| utf-8 | | -| utf8 | | -| latin1 | | - -#### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限
- 'fail sdcard not mounted': Android sdcard 挂载失败 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| entries | `{ [path: string]: FileItem; }` | 文件读取结果。res.entries 是一个对象，key是文件路径，value是一个对象 FileItem ，表示该文件的读取结果。每个 FileItem 包含 data （文件内容） 和 errMsg （错误信息） 属性。 | - -#### FileItem - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | string or ArrayBuffer | 文件内容 | -| errMsg | `string` | 错误信息 | - -### RemoveSavedFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 需要删除的文件路径 | -| apFilePath | `string` | 否 | 本地缓存文件路径
API 支持度: alipay | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: RemoveSavedFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RemoveSavedFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail file not exist': 指定的 tempFilePath 找不到文件; | - -### RenameOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| newPath | `string` | 是 | 新文件路径 | -| oldPath | `string` | 是 | 源文件路径，可以是普通文件或目录 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: RenameFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RenameFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail permission denied, rename ${oldPath} -> ${newPath}': 指定源文件或目标文件没有写权限;
- 'fail no such file or directory, rename ${oldPath} -> ${newPath}': 源文件不存在，或目标文件路径的上层目录不存在; | - -### RmdirOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| dirPath | `string` | 是 | 要删除的目录路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: RmdirFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| recursive | `boolean` | 否 | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RmdirFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory ${dirPath}': 目录不存在;
- 'fail directory not empty': 目录不为空;
- 'fail permission denied, open ${dirPath}': 指定的 dirPath 路径没有写权限; | - -### SaveFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tempFilePath | `string` | 是 | 临时存储文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: SaveFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| filePath | `string` | 否 | 要存储的文件路径 | -| success | `(result: SaveFileSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SaveFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;
- 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;
- 'fail no such file or directory "${dirPath}"': 上级目录不存在;
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足; | - -### SaveFileSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| savedFilePath | `string` | 存储后的文件路径 | -| errMsg | `string` | 调用结果 | - -### StatOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 文件/目录路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: StatFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| recursive | `boolean` | 否 | 是否递归获取目录下的每个文件的 Stats 信息 | -| success | `(result: StatSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StatFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
- 'fail no such file or directory ${path}': 文件不存在; | - -### StatSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| stats | `any` | [Stats](/docs/apis/files/Stats) or Object

当 recursive 为 false 时，res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时，res.stats 是一个 Object，key 以 path 为根路径的相对路径，value 是该路径对应的 Stats 对象。 | -| errMsg | `string` | 调用结果 | - -### UnlinkOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要删除的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: UnlinkFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### UnlinkFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
- 'fail no such file or directory ${path}': 文件不存在;
- 'fail operation not permitted, unlink ${filePath}': 传入的 filePath 是一个目录; | - -### UnzipOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| targetPath | `string` | 是 | 目标目录路径 | -| zipFilePath | `string` | 是 | 源文件路径，只可以是 zip 压缩文件 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: UnzipFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### UnzipFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail permission denied, unzip ${zipFilePath} -> ${destPath}': 指定目标文件路径没有写权限;
- 'fail no such file or directory, unzip ${zipFilePath} -> "${destPath}': 源文件不存在，或目标文件路径的上层目录不存在; | - -### WriteFileOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | string or ArrayBuffer | 是 | 要写入的文本或二进制数据 | -| filePath | `string` | 是 | 要写入的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| encoding | `keyof Encoding` | 否 | 指定写入文件的字符编码 | -| fail | `(result: WriteFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### WriteFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足; | - -### FstatOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FstatFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: FstatSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FstatFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'bad file descriptor': 无效的文件描述符;
- 'fail permission denied': 指定的 fd 路径没有读权限; | - -### FstatSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| stats | `Stats` | Stats 对象，包含了文件的状态信息 | -| errMsg | `string` | 调用结果 | - -### FstatSyncOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fd | `string` | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | - -### CloseOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: CloseFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CloseFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'bad file descriptor': 无效的文件描述符 | - -### CloseSyncOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fd | `string` | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | - -### FtruncateOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| length | `number` | 是 | 截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'） | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FtruncateFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FtruncateFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'bad file descriptor': 无效的文件描述符
- 'fail permission denied': 指定的 fd 没有写权限
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足
- 'fail sdcard not mounted android sdcard': 挂载失败 | - -### FtruncateSyncOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fd | `string` | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| length | `number` | 截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'） | - -### OpenOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 文件路径 (本地路径) | -| flag | `keyof flag` | 否 | 文件系统标志，默认值: 'r' | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: OpenFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: OpenSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### OpenFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory "${filePath}"': 上级目录不存在 | - -### OpenSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fd | `string` | 文件描述符 | -| errMsg | `string` | 调用结果 | - -### OpenSyncOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 文件路径 (本地路径) | -| flag | `keyof flag` | 否 | 文件系统标志，默认值: 'r' | - -### ReadOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| arrayBuffer | `ArrayBuffer` | 是 | 数据写入的缓冲区，必须是 ArrayBuffer 实例 | -| offset | `number` | 否 | 缓冲区中的写入偏移量，默认0 | -| length | `number` | 否 | 要从文件中读取的字节数，默认0 | -| position | `number` | 否 | 文件读取的起始位置，如不传或传 null，则会从当前文件指针的位置读取。如果 position 是正整数，则文件指针位置会保持不变并从 position 读取文件。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: ReadFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: ReadSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ReadFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'bad file descriptor': 无效的文件描述符
- 'fail permission denied': 指定的 fd 路径没有读权限
- 'fail the value of "offset" is out of range': 传入的 offset 不合法
- 'fail the value of "length" is out of range': 传入的 length 不合法
- 'fail sdcard not mounted': android sdcard 挂载失败
- 'bad file descriptor': 无效的文件描述符 | - -### ReadSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bytesRead | `string` | 实际读取的字节数 | -| arrayBuffer | `ArrayBuffer` | 被写入的缓存区的对象，即接口入参的 arrayBuffer | -| errMsg | `string` | 调用结果 | - -### readCompressedFile - -#### Promised - -```tsx -FailCallbackResult | SuccessCallbackResult -``` - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要读取的文件的路径 (本地用户文件或代码包文件) | -| compressionAlgorithm | `string` | 是 | 文件压缩类型，目前仅支持 'br'。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### CompressionAlgorithm - -文件压缩类型合法值 - -| 参数 | 说明 | -| --- | --- | -| br | brotli压缩文件 | - -#### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail decompress fail': 指定的 compressionAlgorithm 与文件实际压缩格式不符
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `ArrayBuffer` | 文件内容 | - -### readCompressedFileSync - -#### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| filePath | `string` | 要读取的文件的路径 (本地用户文件或代码包文件) | -| compressionAlgorithm | `string` | 文件压缩类型，目前仅支持 'br'。 | - -#### CompressionAlgorithm - -文件压缩类型合法值 - -| 参数 | 说明 | -| --- | --- | -| br | brotli压缩文件 | - -### ReadSyncOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| arrayBuffer | `ArrayBuffer` | 是 | 数据写入的缓冲区，必须是 ArrayBuffer 实例 | -| offset | `number` | 否 | 缓冲区中的写入偏移量，默认0 | -| length | `number` | 否 | 要从文件中读取的字节数，默认0 | -| position | `number` | 否 | 文件读取的起始位置，如不传或传 null，则会从当前文件指针的位置读取。如果 position 是正整数，则文件指针位置会保持不变并从 position 读取文件。 | - -### TruncateOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要截断的文件路径 (本地路径) | -| length | `number` | 否 | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'） | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: TruncateFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### TruncateFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在
- 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录
- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足
- 'fail sdcard not mounted': android sdcard 挂载失败 | - -### TruncateSyncOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要截断的文件路径 (本地路径) | -| length | `number` | 否 | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'） | - -### WriteOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| data | string or ArrayBuffer | 是 | 写入的内容，类型为 String 或 ArrayBuffer | -| offset | `number` | 否 | 只在 data 类型是 ArrayBuffer 时有效，决定 arrayBuffe 中要被写入的部位，即 arrayBuffer 中的索引，默认0 | -| length | `number` | 否 | 只在 data 类型是 ArrayBuffer 时有效，指定要写入的字节数，默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 | -| encoding | `keyof Encoding` | 否 | 只在 data 类型是 String 时有效，指定写入文件的字符编码，默认为 utf8 | -| position | `number` | 否 | 指定文件开头的偏移量，即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时，数据会被写入当前指针所在位置。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: WriteFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: WriteSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### WriteFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
'bad file descriptor': 无效的文件描述符
'fail permission denied': 指定的 fd 路径没有写权限
'fail sdcard not mounted': android sdcard 挂载失败 | - -### WriteSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bytesWritten | `number` | 实际被写入到文件中的字节数（注意，被写入的字节数不一定与被写入的字符串字符数相同） | -| errMsg | `string` | 调用结果 | - -### WriteSyncOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fd | `string` | 是 | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | -| data | string or ArrayBuffer | 是 | 写入的内容，类型为 String 或 ArrayBuffer | -| offset | `number` | 否 | 只在 data 类型是 ArrayBuffer 时有效，决定 arrayBuffe 中要被写入的部位，即 arrayBuffer 中的索引，默认0 | -| length | `number` | 否 | 只在 data 类型是 ArrayBuffer 时有效，指定要写入的字节数，默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 | -| encoding | `keyof Encoding` | 否 | 只在 data 类型是 String 时有效，指定写入文件的字符编码，默认为 utf8 | -| position | `number` | 否 | 指定文件开头的偏移量，即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时，数据会被写入当前指针所在位置。 | - -## API 支持度 - -| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| FileSystemManager | ✔️ | | | ✔️ | | | | | | -| FileSystemManager.access | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.accessSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.appendFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.appendFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.close | ✔️ | | | | | | | | | -| FileSystemManager.closeSync | ✔️ | | | | | | | | | -| FileSystemManager.copyFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.copyFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.fstat | ✔️ | | | | | | | | | -| FileSystemManager.fstatSync | ✔️ | | | | | | | | | -| FileSystemManager.ftruncate | ✔️ | | | | | | | | | -| FileSystemManager.ftruncateSync | ✔️ | | | | | | | | | -| FileSystemManager.getFileInfo | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.getSavedFileList | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.mkdir | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.mkdirSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.open | ✔️ | | | | | | | | | -| FileSystemManager.openSync | ✔️ | | | | | | | | | -| FileSystemManager.read | ✔️ | | | | | | | | | -| FileSystemManager.readCompressedFile | ✔️ | | | | | | | | | -| FileSystemManager.readCompressedFileSync | ✔️ | | | | | | | | | -| FileSystemManager.readdir | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.readdirSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.readFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.readFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.readSync | ✔️ | | | | | | | | | -| FileSystemManager.readZipEntry | ✔️ | | | | | | | | | -| FileSystemManager.removeSavedFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.rename | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.renameSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.rmdir | ✔️ | | | ✔️ | | | | | | -| FileSystemManager.rmdirSync | ✔️ | | | ✔️ | | | | | | -| FileSystemManager.saveFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.saveFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.stat | ✔️ | ✔️ | ✔️ | | ✔️ | ✔️ | | | | -| FileSystemManager.statSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.truncate | ✔️ | | | ✔️ | | | | | | -| FileSystemManager.truncateSync | ✔️ | | | ✔️ | | | | | | -| FileSystemManager.unlink | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.unlinkSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.unzip | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.write | ✔️ | | | | | | | | | -| FileSystemManager.writeFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.writeFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| FileSystemManager.writeSync | ✔️ | | | | | | | | | diff --git a/versioned_docs/version-4.x/apis/files/ReadResult.md b/versioned_docs/version-4.x/apis/files/ReadResult.md deleted file mode 100644 index e2079608c1df..000000000000 --- a/versioned_docs/version-4.x/apis/files/ReadResult.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: ReadResult -sidebar_label: ReadResult ---- - -文件读取结果。 通过 [FileSystemManager.readSync](./FileSystemManager#readsync) 接口返回 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/ReadResult.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bytesRead | `number` | 实际读取的字节数 | -| arrayBuffer | `ArrayBuffer` | 被写入的缓存区的对象，即接口入参的 arrayBuffer | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| ReadResult | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/files/Stats.md b/versioned_docs/version-4.x/apis/files/Stats.md deleted file mode 100644 index e8f95ea64ba5..000000000000 --- a/versioned_docs/version-4.x/apis/files/Stats.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Stats -sidebar_label: Stats ---- - -描述文件状态的对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mode | `string` | 文件的类型和存取的权限，对应 POSIX stat.st_mode | -| size | `number` | 文件大小，单位：B，对应 POSIX stat.st_size | -| lastAccessedTime | `number` | 文件最近一次被存取或被执行的时间，UNIX 时间戳，对应 POSIX stat.st_atime | -| lastModifiedTime | `number` | 文件最后一次被修改的时间，UNIX 时间戳，对应 POSIX stat.st_mtime | - -### isDirectory - -判断当前文件是否一个目录 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isDirectory.html) - -```tsx -() => boolean -``` - -### isFile - -判断当前文件是否一个普通文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isFile.html) - -```tsx -() => boolean -``` - -## API 支持度 - -| API | 微信小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| Stats | ✔️ | | | | | | | | -| Stats.isDirectory | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | -| Stats.isFile | ✔️ | | ✔️ | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/files/WriteResult.md b/versioned_docs/version-4.x/apis/files/WriteResult.md deleted file mode 100644 index 7b11c0b291a1..000000000000 --- a/versioned_docs/version-4.x/apis/files/WriteResult.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: WriteResult -sidebar_label: WriteResult ---- - -文件写入结果。 通过 [FileSystemManager.writeSync](./FileSystemManager#writesync) 接口返回 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/WriteResult.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bytesWritten | `number` | 实际被写入到文件中的字节数（注意，被写入的字节数不一定与被写入的字符串字符数相同） | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| WriteResult | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/files/getFileInfo.md b/versioned_docs/version-4.x/apis/files/getFileInfo.md deleted file mode 100644 index 521e5371512b..000000000000 --- a/versioned_docs/version-4.x/apis/files/getFileInfo.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.getFileInfo(option) -sidebar_label: getFileInfo ---- - -获取该小程序下的 本地临时文件 或 本地缓存文件 信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileInfo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| filePath | `string` | | 是 | 要读取的文件路径 | -| apFilePath | `string` | | 否 | 本地文件路径
API 支持度: alipay | -| digestAlgorithm | "md5" or "sha1" | `'md5'` | 否 | 计算文件摘要的算法 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail file not exist': 指定的 filePath 找不到文件; | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| size | `number` | 文件大小，以字节为单位 | -| digest | `string` | 按照传入的 digestAlgorithm 计算得出的的文件摘要 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.getFileInfo({ - success: function (res) { - console.log(res.size) - console.log(res.digest) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/getFileSystemManager.md b/versioned_docs/version-4.x/apis/files/getFileSystemManager.md deleted file mode 100644 index 08172540cfc4..000000000000 --- a/versioned_docs/version-4.x/apis/files/getFileSystemManager.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.getFileSystemManager() -sidebar_label: getFileSystemManager ---- - -获取全局唯一的文件管理器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileSystemManager.html) - -## 类型 - -```tsx -() => FileSystemManager -``` diff --git a/versioned_docs/version-4.x/apis/files/getSavedFileInfo.md b/versioned_docs/version-4.x/apis/files/getSavedFileInfo.md deleted file mode 100644 index 20ffde1f3fbb..000000000000 --- a/versioned_docs/version-4.x/apis/files/getSavedFileInfo.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Taro.getSavedFileInfo(option) -sidebar_label: getSavedFileInfo ---- - -获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，请使用 [Taro.getFileInfo](/docs/apis/files/getFileInfo) 接口。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileInfo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 文件路径 | -| apFilePath | `string` | 否 | 文件路径
API 支持度: alipay | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| createTime | `number` | 文件保存时的时间戳，从1970/01/01 08:00:00 到该时刻的秒数 | -| size | `number` | 文件大小，单位 B | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.getSavedFileInfo({ - filePath: 'wxfile://somefile', //仅做示例用，非真正的文件路径 - success: function (res) { - console.log(res.size) - console.log(res.createTime) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/getSavedFileList.md b/versioned_docs/version-4.x/apis/files/getSavedFileList.md deleted file mode 100644 index 6025c2a0d459..000000000000 --- a/versioned_docs/version-4.x/apis/files/getSavedFileList.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.getSavedFileList(option) -sidebar_label: getSavedFileList ---- - -获取本地已保存的文件列表 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileList.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fileList | `FileItem[]` | 文件数组 | -| errMsg | `string` | 调用结果 | - -### FileItem - -文件数组 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| createTime | `number` | 是 | 文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数 | -| filePath | `string` | 是 | 本地路径 | -| apFilePath | `string` | 否 | 文件路径
API 支持度: alipay | -| size | `number` | 是 | 本地文件大小，以字节为单位 | - -## 示例代码 - -```tsx -Taro.getSavedFileList({ - success: function (res) { - console.log(res.fileList) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/openDocument.md b/versioned_docs/version-4.x/apis/files/openDocument.md deleted file mode 100644 index 6a7775821e30..000000000000 --- a/versioned_docs/version-4.x/apis/files/openDocument.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Taro.openDocument(option) -sidebar_label: openDocument ---- - -新开页面打开文档，支持格式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.openDocument.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 文件路径，可通过 downloadFile 获得 | -| showMenu | `boolean` | 否 | 是否显示右上角菜单 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| fileType | `keyof FileType` | 否 | 文件类型，指定文件类型打开文件 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FileType - -文件类型 - -| 参数 | 说明 | -| --- | --- | -| doc | doc 格式 | -| docx | docx 格式 | -| xls | xls 格式 | -| xlsx | xlsx 格式 | -| ppt | ppt 格式 | -| pptx | pptx 格式 | -| pdf | pdf 格式 | - -## 示例代码 - -```tsx -Taro.downloadFile({ - url: 'https://example.com/somefile.pdf', - success: function (res) { - var filePath = res.tempFilePath - Taro.openDocument({ - filePath: filePath, - success: function (res) { - console.log('打开文档成功') - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/removeSavedFile.md b/versioned_docs/version-4.x/apis/files/removeSavedFile.md deleted file mode 100644 index 46368bb8ea23..000000000000 --- a/versioned_docs/version-4.x/apis/files/removeSavedFile.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Taro.removeSavedFile(option) -sidebar_label: removeSavedFile ---- - -删除该小程序下已保存的本地缓存文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.removeSavedFile.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 需要删除的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RemoveSavedFileFailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail file not exist': 指定的 tempFilePath 找不到文件; | - -## 示例代码 - -```tsx -Taro.getSavedFileList({ - success: function (res) { - if (res.fileList.length > 0){ - Taro.removeSavedFile({ - filePath: res.fileList[0].filePath, - complete: function (res) { - console.log(res) - } - }) - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/saveFile.md b/versioned_docs/version-4.x/apis/files/saveFile.md deleted file mode 100644 index 8708606b6a89..000000000000 --- a/versioned_docs/version-4.x/apis/files/saveFile.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Taro.saveFile(option) -sidebar_label: saveFile ---- - -保存文件到本地。**注意：saveFile 会把临时文件移动，因此调用成功后传入的 tempFilePath 将不可用** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFile.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tempFilePath | `string` | 是 | 临时存储文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| filePath | `string` | 否 | 要存储的文件路径 | -| apFilePath | `string` | 否 | 要保存的本地临时文件路径
API 支持度: alipay | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;
- 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;
- 'fail no such file or directory "${dirPath}"': 上级目录不存在;
- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足; | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| savedFilePath | `string` | 存储后的文件路径 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.chooseImage({ - success: function (res) { - var tempFilePaths = res.tempFilePaths - Taro.saveFile({ - tempFilePath: tempFilePaths[0], - success: function (res) { - var savedFilePath = res.savedFilePath - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/files/saveFileToDisk.md b/versioned_docs/version-4.x/apis/files/saveFileToDisk.md deleted file mode 100644 index 9cf2359cb2e5..000000000000 --- a/versioned_docs/version-4.x/apis/files/saveFileToDisk.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.saveFileToDisk(option) -sidebar_label: saveFileToDisk ---- - -保存文件系统的文件到用户磁盘，仅在 PC 端支持 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFileToDisk.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 待保存文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.saveFileToDisk({ - filePath: `${Taro.env.USER_DATA_PATH}/hello.txt`, - success(res) { - console.log(res) - }, - fail(res) { - console.error(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/framework/App.md b/versioned_docs/version-4.x/apis/framework/App.md deleted file mode 100644 index 4bbe70b0ff33..000000000000 --- a/versioned_docs/version-4.x/apis/framework/App.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: App -sidebar_label: App ---- - -注册小程序。接受一个 `Object` 参数，其指定小程序的生命周期回调等。 - -## 方法 diff --git a/versioned_docs/version-4.x/apis/framework/Page.md b/versioned_docs/version-4.x/apis/framework/Page.md deleted file mode 100644 index 0a756aa0f196..000000000000 --- a/versioned_docs/version-4.x/apis/framework/Page.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Page -sidebar_label: Page ---- - -注册小程序中的一个页面。接受一个 `Object` 类型参数，其指定页面的初始数据、生命周期回调、事件处理函数等。 - -## 方法 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| route | `string` | 否 | 当前页面的路径
note: 推荐使用 Taro.getCurrentInstance().router?.path 方法 | -| __route__ | `string` | 否 | | diff --git a/versioned_docs/version-4.x/apis/framework/getApp.md b/versioned_docs/version-4.x/apis/framework/getApp.md deleted file mode 100644 index 9df0e4121ce1..000000000000 --- a/versioned_docs/version-4.x/apis/framework/getApp.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.getApp(opts) -sidebar_label: getApp ---- - -获取到小程序全局唯一的 App 实例。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/reference/api/getApp.html) - -## 类型 - -```tsx -(opts?: Option) => Instance -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| opts | `T` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| allowDefault | `boolean` | 否 | 在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包 | - -### Instance - -```tsx -Option | T -``` diff --git a/versioned_docs/version-4.x/apis/framework/getCurrentPages.md b/versioned_docs/version-4.x/apis/framework/getCurrentPages.md deleted file mode 100644 index a4a567ff076c..000000000000 --- a/versioned_docs/version-4.x/apis/framework/getCurrentPages.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Taro.getCurrentPages() -sidebar_label: getCurrentPages ---- - -获取当前页面栈。数组中第一个元素为首页，最后一个元素为当前页面。 -__注意：__ -- __不要尝试修改页面栈，会导致路由以及页面状态错误。__ -- 不要在 `App.onLaunch` 的时候调用 `getCurrentPages()`，此时 `page` 还没有生成。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/reference/api/getCurrentPages.html) - -## 类型 - -```tsx -() => Page[] -``` - -## 示例代码 - -```tsx -Taro.getCurrentPages().length -``` diff --git a/versioned_docs/version-4.x/apis/index.md b/versioned_docs/version-4.x/apis/index.md deleted file mode 100644 index ce6ec4f73ea8..000000000000 --- a/versioned_docs/version-4.x/apis/index.md +++ /dev/null @@ -1,1420 +0,0 @@ -# 小程序 API 列表 - -## 基础 - -Taro.env 环境变量 -Taro.canIUse 判断小程序的API，回调，参数，组件等是否在当前版本可用 -Taro.base64ToArrayBuffer 将 Base64 字符串转成 ArrayBuffer 对象 -Taro.arrayBufferToBase64 将 ArrayBuffer 对象转成 Base64 字符串 - -### 系统 - -Taro.openSystemBluetoothSetting 跳转系统蓝牙设置页 -Taro.openAppAuthorizeSetting 跳转系统微信授权管理页 -Taro.getWindowInfo 获取窗口信息 -Taro.getSystemSetting 获取设备设置 -Taro.getSystemInfoSync Taro.getSystemInfo 的同步版本 -Taro.getSystemInfoAsync 异步获取系统信息 -Taro.getSystemInfo 获取系统信息 -Taro.getDeviceInfo 获取设备基础信息 -Taro.getAppBaseInfo 获取微信APP基础信息 -Taro.getAppAuthorizeSetting 获取微信APP授权设置 - -### 更新 - -Taro.updateWeChatApp 更新客户端版本 -Taro.getUpdateManager 获取全局唯一的版本更新管理器，用于管理小程序更新 - -#### UpdateManager - -UpdateManager.applyUpdate 强制小程序重启并使用新版本 -UpdateManager.onCheckForUpdate 监听向微信后台请求检查更新结果事件 -UpdateManager.onUpdateFailed 监听小程序更新失败事件 -UpdateManager.onUpdateReady 监听小程序有版本更新事件 - -### 小程序 - -#### 生命周期 - -Taro.getLaunchOptionsSync 获取小程序启动时的参数 -Taro.getEnterOptionsSync 获取本次小程序启动时的参数 - -#### 应用级事件 - -Taro.onUnhandledRejection 监听未处理的 Promise 拒绝事件 -Taro.onThemeChange 监听系统主题改变事件 -Taro.onPageNotFound 监听小程序要打开的页面不存在事件 -Taro.onError 监听小程序错误事件 -Taro.onAudioInterruptionEnd 监听音频中断结束事件 -Taro.onAudioInterruptionBegin 监听音频因为受到系统占用而被中断开始事件 -Taro.onAppShow 小程序切前台事件 -Taro.onAppHide 监听小程序切后台事件 -Taro.offUnhandledRejection 取消监听未处理的 Promise 拒绝事件 -Taro.offThemeChange 取消监听系统主题改变事件 -Taro.offPageNotFound 取消监听小程序要打开的页面不存在事件 -Taro.offError 取消监听小程序错误事件 -Taro.offAudioInterruptionEnd 取消监听音频中断结束事件 -Taro.offAudioInterruptionBegin 取消监听音频因为受到系统占用而被中断开始事件 -Taro.offAppShow 取消监听小程序切前台事件 -Taro.offAppHide 取消监听小程序切后台事件 - -### 调试 - -Taro.setEnableDebug 设置是否打开调试开关 -Taro.getRealtimeLogManager 获取实时日志管理器对象 -Taro.getLogManager 获取日志管理器对象 - -#### console - -console.debug 向调试面板中打印 debug 日志 -console.error 向调试面板中打印 error 日志 -console.group 在调试面板中创建一个新的分组 -console.groupEnd 结束由 console.group 创建的分组 -console.info 向调试面板中打印 info 日志 -console.log 向调试面板中打印 log 日志 -console.warn 向调试面板中打印 warn 日志 - -#### LogManager - -LogManager.debug 写 debug 日志 -LogManager.info 写 info 日志 -LogManager.log 写 log 日志 -LogManager.warn 写 warn 日志 - -#### RealtimeLogManager - -RealtimeLogManager.addFilterMsg 添加过滤关键字，暂不支持在插件使用 -RealtimeLogManager.error 写 error 日志，暂不支持在插件使用 -RealtimeLogManager.getCurrentState 实时日志会将一定时间间隔内缓存的日志聚合上报，如果该时间内缓存的内容超出限制，则会被丢弃 -RealtimeLogManager.in 设置实时日志page参数所在的页面，暂不支持在插件使用 -RealtimeLogManager.info 写 info 日志，暂不支持在插件使用 -RealtimeLogManager.setFilterMsg 设置过滤关键字，暂不支持在插件使用 -RealtimeLogManager.tag 获取给定标签的日志管理器实例，目前只支持在插件使用 -RealtimeLogManager.warn 写 warn 日志，暂不支持在插件使用 - -#### RealtimeTagLogManager - -RealtimeTagLogManager.addFilterMsg 添加过滤关键字 -RealtimeTagLogManager.error 写 error 日志 -RealtimeTagLogManager.info 写 info 日志 -RealtimeTagLogManager.setFilterMsg 设置过滤关键字 -RealtimeTagLogManager.warn 写 warn 日志 - -### 性能 - -Taro.reportPerformance 小程序测速上报 -Taro.getPerformance 获取当前小程序性能相关的信息 - -#### EntryList - -EntryList.getEntries 该方法返回当前列表中的所有性能数据 -EntryList.getEntriesByName 获取当前列表中所有名称为 [name] 且类型为 [entryType] 的性能数据 -EntryList.getEntriesByType 获取当前列表中所有类型为 [entryType] 的性能数据 - -#### Performance - -Performance.createObserver 创建全局性能事件监听器 -Performance.getEntries 该方法返回当前缓冲区中的所有性能数据 -Performance.getEntriesByName 获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据 -Performance.getEntriesByType 获取当前缓冲区中所有类型为 [entryType] 的性能数据 -Performance.setBufferSize 设置缓冲区大小，默认缓冲 30 条性能数据 - -#### PerformanceEntry 单条性能数据 - -#### PerformanceObserver - -PerformanceObserver.disconnect 停止监听 -PerformanceObserver.observe 开始监听 - -### 加密 - -Taro.getUserCryptoManager 获取用户加密模块 - -#### UserCryptoManager - -UserCryptoManager.getLatestUserKey 获取最新的用户加密密钥 -UserCryptoManager.getRandomValues 获取密码学安全随机数 - -## 路由 - -Taro.switchTab 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 -Taro.reLaunch 关闭所有页面，打开到应用内的某个页面 -Taro.redirectTo 关闭当前页面，跳转到应用内的某个页面 -Taro.navigateTo 保留当前页面，跳转到应用内的某个页面 -Taro.navigateBack 关闭当前页面，返回上一页面或多级页面 - -### EventChannel - -EventChannel.emit 触发一个事件 -EventChannel.off 取消监听一个事件 -EventChannel.on 持续监听一个事件 -EventChannel.once 监听一个事件一次，触发后失效 - -## 跳转 - -Taro.openEmbeddedMiniProgram 打开半屏小程序 -Taro.navigateToMiniProgram 打开另一个小程序 -Taro.navigateBackMiniProgram 返回到上一个小程序 -Taro.exitMiniProgram 退出当前小程序 - -## 转发 - -Taro.updateShareMenu 更新转发属性 -Taro.showShareMenu 显示当前页面的转发按钮 -Taro.showShareImageMenu 打开分享图片弹窗，可以将图片发送给朋友、收藏或下载 -Taro.shareVideoMessage 转发视频到聊天 -Taro.shareFileMessage 转发文件到聊天 -Taro.onCopyUrl 监听用户点击右上角菜单的「复制链接」按钮时触发的事件 -Taro.offCopyUrl 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件 -Taro.hideShareMenu 隐藏当前页面的转发按钮 -Taro.getShareInfo 获取转发详细信息 -Taro.authPrivateMessage 验证私密消息 - -## 界面 - -### 交互 - -Taro.showToast 显示消息提示框 -Taro.showModal 显示模态对话框 -Taro.showLoading 显示 loading 提示框 -Taro.showActionSheet 显示操作菜单 -Taro.hideToast 隐藏消息提示框 -Taro.hideLoading 隐藏 loading 提示框 -Taro.enableAlertBeforeUnload 开启小程序页面返回询问对话框 -Taro.disableAlertBeforeUnload 关闭小程序页面返回询问对话框 - -### 导航栏 - -Taro.showNavigationBarLoading 在当前页面显示导航条加载动画 -Taro.setNavigationBarTitle 动态设置当前页面的标题 -Taro.setNavigationBarColor 设置页面导航条颜色 -Taro.hideNavigationBarLoading 在当前页面隐藏导航条加载动画 -Taro.hideHomeButton 隐藏返回首页按钮 - -### 背景 - -Taro.setBackgroundTextStyle 动态设置下拉背景字体、loading 图的样式 -Taro.setBackgroundColor 动态设置窗口的背景色 - -### Tab Bar - -Taro.showTabBarRedDot 显示 tabBar 某一项的右上角的红点 -Taro.showTabBar 显示 tabBar -Taro.setTabBarStyle 动态设置 tabBar 的整体样式 -Taro.setTabBarItem 动态设置 tabBar 某一项的内容，2.7.0 起图片支持临时文件和网络文件 -Taro.setTabBarBadge 为 tabBar 某一项的右上角添加文本 -Taro.removeTabBarBadge 移除 tabBar 某一项右上角的文本 -Taro.hideTabBarRedDot 隐藏 tabBar 某一项的右上角的红点 -Taro.hideTabBar 隐藏 tabBar - -### 字体 - -Taro.loadFontFace 动态加载网络字体，文件地址需为下载类型 - -### 下拉刷新 - -Taro.stopPullDownRefresh 停止当前页面下拉刷新 -Taro.startPullDownRefresh 开始下拉刷新 - -### 滚动 - -Taro.pageScrollTo 将页面滚动到目标位置，支持选择器和滚动距离两种方式定位 - -#### ScrollViewContext - -ScrollViewContext.scrollIntoView 滚动至指定位置 -ScrollViewContext.scrollTo 滚动至指定位置 - -### 动画 - -Taro.createAnimation 创建一个动画实例 animation - -#### Animation - -Animation.backgroundColor 设置背景色 -Animation.bottom 设置 bottom 值 -Animation.export 导出动画队列 -Animation.height 设置高度 -Animation.left 设置 left 值 -Animation.matrix 同 transform-function matrix -Animation.matrix3d 同 transform-function matrix3d -Animation.opacity 设置透明度 -Animation.right 设置 right 值 -Animation.rotate 从原点顺时针旋转一个角度 -Animation.rotate3d 从 固定 轴顺时针旋转一个角度 -Animation.rotateX 从 X 轴顺时针旋转一个角度 -Animation.rotateY 从 Y 轴顺时针旋转一个角度 -Animation.rotateZ 从 Z 轴顺时针旋转一个角度 -Animation.scale 缩放 -Animation.scale3d 缩放 -Animation.scaleX 缩放 X 轴 -Animation.scaleY 缩放 Y 轴 -Animation.scaleZ 缩放 Z 轴 -Animation.skew 对 X、Y 轴坐标进行倾斜 -Animation.skewX 对 X 轴坐标进行倾斜 -Animation.skewY 对 Y 轴坐标进行倾斜 -Animation.step 表示一组动画完成 -Animation.top 设置 top 值 -Animation.translate 平移变换 -Animation.translate3d 对 xyz 坐标进行平移变换 -Animation.translateX 对 X 轴平移 -Animation.translateY 对 Y 轴平移 -Animation.translateZ 对 Z 轴平移 -Animation.width 设置宽度 - -### 置顶 - -Taro.setTopBarText 动态设置置顶栏文字内容 - -### 自定义组件 - -Taro.nextTick 延迟一部分操作到下一个时间片再执行 - -### 菜单 - -Taro.getMenuButtonBoundingClientRect 获取菜单按钮（右上角胶囊按钮）的布局位置信息 - -### 窗口 - -Taro.setWindowSize 设置窗口大小，该接口仅适用于 PC 平台，使用细则请参见指南 -Taro.onWindowResize 监听窗口尺寸变化事件 -Taro.offWindowResize 取消监听窗口尺寸变化事件 - -## 网络 - -### 发起请求 - -Taro.request 发起 HTTPS 网络请求 - -#### RequestTask - -RequestTask.abort 中断请求任务 -RequestTask.offChunkReceived 取消监听 Transfer-Encoding Chunk Received 事件 -RequestTask.offHeadersReceived 取消监听 HTTP Response Header 事件 -RequestTask.onChunkReceived 监听 Transfer-Encoding Chunk Received 事件 -RequestTask.onHeadersReceived 监听 HTTP Response Header 事件 - -### 下载 - -Taro.downloadFile 下载文件资源到本地 - -#### DownloadTask - -DownloadTask.abort 中断下载任务 -DownloadTask.offHeadersReceived 取消监听 HTTP Response Header 事件 -DownloadTask.offProgressUpdate 取消监听下载进度变化事件 -DownloadTask.onHeadersReceived 监听 HTTP Response Header 事件 -DownloadTask.onProgressUpdate 监听下载进度变化事件 - -### 上传 - -Taro.uploadFile 将本地资源上传到服务器 - -#### UploadTask - -UploadTask.abort 中断上传任务 -UploadTask.offHeadersReceived 取消监听 HTTP Response Header 事件 -UploadTask.offProgressUpdate 取消监听上传进度变化事件 -UploadTask.onHeadersReceived 监听 HTTP Response Header 事件 -UploadTask.onProgressUpdate 监听上传进度变化事件 - -### WebSocket - -Taro.sendSocketMessage 通过 WebSocket 连接发送数据 -Taro.onSocketOpen 监听 WebSocket 连接打开事件 -Taro.onSocketMessage 监听 WebSocket 接受到服务器的消息事件 -Taro.onSocketError 监听 WebSocket 错误事件 -Taro.onSocketClose 监听 WebSocket 连接关闭事件 -Taro.connectSocket 创建一个 WebSocket 连接 -Taro.closeSocket 关闭 WebSocket 连接 - -#### SocketTask - -SocketTask.close 关闭 WebSocket 连接 -SocketTask.onClose 监听 WebSocket 连接关闭事件 -SocketTask.onError 监听 WebSocket 错误事件 -SocketTask.onMessage 监听 WebSocket 接受到服务器的消息事件 -SocketTask.onOpen 监听 WebSocket 连接打开事件 -SocketTask.send 通过 WebSocket 连接发送数据 - -### mDNS - -Taro.stopLocalServiceDiscovery 停止搜索 mDNS 服务 -Taro.startLocalServiceDiscovery 开始搜索局域网下的 mDNS 服务 -Taro.onLocalServiceResolveFail 监听 mDNS 服务解析失败的事件 -Taro.onLocalServiceLost 监听 mDNS 服务离开的事件 -Taro.onLocalServiceFound 监听 mDNS 服务发现的事件 -Taro.onLocalServiceDiscoveryStop 监听 mDNS 服务停止搜索的事件 -Taro.offLocalServiceResolveFail 取消监听 mDNS 服务解析失败的事件 -Taro.offLocalServiceLost 取消监听 mDNS 服务离开的事件 -Taro.offLocalServiceFound 取消监听 mDNS 服务发现的事件 -Taro.offLocalServiceDiscoveryStop 取消监听 mDNS 服务停止搜索的事件 - -### TCP 通信 - -Taro.createTCPSocket 创建一个 TCP Socket 实例 - -#### TCPSocket - -TCPSocket.close 关闭连接 -TCPSocket.connect 在给定的套接字上启动连接 -TCPSocket.offClose 取消监听一旦 socket 完全关闭就发出该事件 -TCPSocket.offConnect 取消监听当一个 socket 连接成功建立的时候触发该事件 -TCPSocket.offError 取消监听当错误发生时触发 -TCPSocket.offMessage 取消监听当接收到数据的时触发该事件 -TCPSocket.onClose 监听一旦 socket 完全关闭就发出该事件 -TCPSocket.onConnect 监听当一个 socket 连接成功建立的时候触发该事件 -TCPSocket.onError 监听当错误发生时触发 -TCPSocket.onMessage 监听当接收到数据的时触发该事件 -TCPSocket.write 在 socket 上发送数据 - -### UDP 通信 - -Taro.createUDPSocket 创建一个 UDP Socket 实例 - -#### UDPSocket - -UDPSocket.bind 绑定一个系统随机分配的可用端口，或绑定一个指定的端口号 -UDPSocket.close 关闭 UDP Socket 实例，相当于销毁 -UDPSocket.connect 预先连接到指定的 IP 和 port，需要配合 write 方法一起使用 -UDPSocket.offClose 取消监听关闭事件 -UDPSocket.offError 取消监听错误事件 -UDPSocket.offListening 取消监听开始监听数据包消息的事件 -UDPSocket.offMessage 取消监听收到消息的事件 -UDPSocket.onClose 监听关闭事件 -UDPSocket.onError 监听错误事件 -UDPSocket.onListening 监听开始监听数据包消息的事件 -UDPSocket.onMessage 监听收到消息的事件 -UDPSocket.send 向指定的 IP 和 port 发送消息 -UDPSocket.setTTL 设置 IP_TTL 套接字选项，用于设置一个 IP 数据包传输时允许的最大跳步数 -UDPSocket.write 用法与 send 方法相同，如果没有预先调用 connect 则与 send 无差异（注意即使调用了 connect 也需要在本接口填入地址和端口参数） - -## 支付 - -Taro.requestPayment 发起微信支付 -Taro.requestOrderPayment 创建自定义版交易组件订单，并发起支付 - -## 数据缓存 - -Taro.setStorageSync 将数据存储在本地缓存中指定的 key 中 -Taro.setStorage 将数据存储在本地缓存中指定的 key 中 -Taro.revokeBufferURL 根据 URL 销毁存在内存中的数据 -Taro.removeStorageSync Taro.removeStorage 的同步版本 -Taro.removeStorage 从本地缓存中移除指定 key -Taro.getStorageSync 从本地缓存中同步获取指定 key 的内容 -Taro.getStorageInfoSync Taro.getStorageInfo 的同步版本 -Taro.getStorageInfo 异步获取当前storage的相关信息 -Taro.getStorage 从本地缓存中异步获取指定 key 的内容 -Taro.createBufferURL 根据传入的 buffer 创建一个唯一的 URL 存在内存中 -Taro.clearStorageSync Taro.clearStorage 的同步版本 -Taro.clearStorage 清理本地数据缓存 - -### 周期性更新 - -Taro.setBackgroundFetchToken 设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性 -Taro.onBackgroundFetchData 监听收到 backgroundFetch 数据事件 -Taro.getBackgroundFetchToken 获取设置过的自定义登录态 -Taro.getBackgroundFetchData 拉取 backgroundFetch 客户端缓存数据 - -## 数据分析 - -Taro.reportMonitor 自定义业务数据监控上报接口 -Taro.reportEvent 事件上报 -Taro.reportAnalytics 自定义分析数据上报接口 -Taro.getExptInfoSync 给定实验参数数组，获取对应的实验参数值 - -## 画布 - -Taro.createOffscreenCanvas 创建离屏 canvas 实例 -Taro.createCanvasContext 创建 canvas 的绘图上下文 CanvasContext 对象 -Taro.canvasToTempFilePath 把当前画布指定区域的内容导出生成指定大小的图片 -Taro.canvasPutImageData 将像素数据绘制到画布 -Taro.canvasGetImageData 获取 canvas 区域隐含的像素数据 - -### Canvas - -Canvas.cancelAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求 -Canvas.createImage 创建一个图片对象 -Canvas.createImageData 创建一个 ImageData 对象 -Canvas.createPath2D 创建 Path2D 对象 -Canvas.getContext 该方法返回 Canvas 的绘图上下文 -Canvas.requestAnimationFrame 在下次进行重绘时执行 -Canvas.toDataURL 返回一个包含图片展示的 data URI - -### CanvasContext - -CanvasContext.arc 创建一条弧线 -CanvasContext.arcTo 根据控制点和半径绘制圆弧路径 -CanvasContext.beginPath 开始创建一个路径 -CanvasContext.bezierCurveTo 创建三次方贝塞尔曲线路径 -CanvasContext.clearRect 清除画布上在该矩形区域内的内容 -CanvasContext.clip 从原始画布中剪切任意形状和尺寸 -CanvasContext.closePath 关闭一个路径 -CanvasContext.createCircularGradient 创建一个圆形的渐变颜色 -CanvasContext.createLinearGradient 创建一个线性的渐变颜色 -CanvasContext.createPattern 对指定的图像创建模式的方法，可在指定的方向上重复元图像 -CanvasContext.draw 将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中 -CanvasContext.drawImage 绘制图像到画布 -CanvasContext.fill 对当前路径中的内容进行填充 -CanvasContext.fillRect 填充一个矩形 -CanvasContext.fillText 在画布上绘制被填充的文本 -CanvasContext.lineTo 增加一个新点，然后创建一条从上次指定点到目标点的线 -CanvasContext.measureText 测量文本尺寸信息 -CanvasContext.moveTo 把路径移动到画布中的指定点，不创建线条 -CanvasContext.quadraticCurveTo 创建二次贝塞尔曲线路径 -CanvasContext.rect 创建一个矩形路径 -CanvasContext.restore 恢复之前保存的绘图上下文 -CanvasContext.rotate 以原点为中心顺时针旋转当前坐标轴 -CanvasContext.save 保存绘图上下文 -CanvasContext.scale 在调用后，之后创建的路径其横纵坐标会被缩放 -CanvasContext.setFillStyle 设置填充色 -CanvasContext.setFontSize 设置字体的字号 -CanvasContext.setGlobalAlpha 设置全局画笔透明度 -CanvasContext.setLineCap 设置线条的端点样式 -CanvasContext.setLineDash 设置虚线样式 -CanvasContext.setLineJoin 设置线条的交点样式 -CanvasContext.setLineWidth 设置线条的宽度 -CanvasContext.setMiterLimit 设置最大斜接长度 -CanvasContext.setShadow 设定阴影样式 -CanvasContext.setStrokeStyle 设置描边颜色 -CanvasContext.setTextAlign 设置文字的对齐 -CanvasContext.setTextBaseline 设置文字的竖直对齐 -CanvasContext.setTransform 使用矩阵重新设置（覆盖）当前变换的方法 -CanvasContext.stroke 画出当前路径的边框 -CanvasContext.strokeRect 画一个矩形(非填充) -CanvasContext.strokeText 给定的 (x, y) 位置绘制文本描边的方法 -CanvasContext.transform 使用矩阵多次叠加当前变换的方法 -CanvasContext.translate 对当前坐标系的原点 (0, 0) 进行变换 - -### CanvasGradient - -CanvasGradient.addColorStop 添加颜色的渐变点 -Color 颜色 -Image 图片对象 -ImageData ImageData 对象 - -### OffscreenCanvas - -OffscreenCanvas.createImage 创建一个图片对象 -OffscreenCanvas.getContext 该方法返回 OffscreenCanvas 的绘图上下文 - -### Path2D Canvas 2D API 的接口 Path2D 用来声明路径，此路径稍后会被CanvasRenderingContext2D 对象使用 - -### RenderingContext Canvas 绘图上下文 - -## 媒体 - -### 地图 - -Taro.createMapContext 创建 map 上下文 MapContext 对象 - -#### MapContext - -MapContext.addArc 添加弧线，途经点与夹角必须设置一个 -MapContext.addCustomLayer 添加个性化图层 -MapContext.addGroundOverlay 创建自定义图片图层，图片会随着地图缩放而缩放 -MapContext.addMarkers 添加 marker -MapContext.addVisualLayer 添加可视化图层 -MapContext.fromScreenLocation 获取屏幕上的点对应的经纬度，坐标原点为地图左上角 -MapContext.getCenterLocation 获取当前地图中心的经纬度 -MapContext.getRegion 获取当前地图的视野范围 -MapContext.getRotate 获取当前地图的旋转角 -MapContext.getScale 获取当前地图的缩放级别 -MapContext.getSkew 获取当前地图的倾斜角 -MapContext.includePoints 缩放视野展示所有经纬度 -MapContext.initMarkerCluster 初始化点聚合的配置，未调用时采用默认配置 -MapContext.moveAlong 沿指定路径移动 marker，用于轨迹回放等场景 -MapContext.moveToLocation 将地图中心移置当前定位点，此时需设置地图组件 show-location 为true -MapContext.on 监听地图事件 -MapContext.openMapApp 拉起地图APP选择导航 -MapContext.removeArc 删除弧线 -MapContext.removeCustomLayer 移除个性化图层 -MapContext.removeGroundOverlay 移除自定义图片图层 -MapContext.removeMarkers 移除 marker -MapContext.removeVisualLayer 移除可视化图层 -MapContext.setBoundary 限制地图的显示范围 -MapContext.setCenterOffset 设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5] -MapContext.setLocMarkerIcon 设置定位点图标，支持网络路径、本地路径、代码包路径 -MapContext.toScreenLocation 获取经纬度对应的屏幕坐标，坐标原点为地图左上角 -MapContext.translateMarker 平移marker，带动画 -MapContext.updateGroundOverlay 更新自定义图片图层 - -### 图片 - -Taro.saveImageToPhotosAlbum 保存图片到系统相册 -Taro.previewMedia 预览图片和视频 -Taro.previewImage 在新页面中全屏预览图片 -Taro.getImageInfo 获取图片信息 -Taro.editImage 编辑图片接口 -Taro.compressImage 压缩图片接口，可选压缩质量 -Taro.chooseMessageFile 从客户端会话选择文件 -Taro.chooseImage 从本地相册选择图片或使用相机拍照 - -### 视频 - -Taro.saveVideoToPhotosAlbum 保存视频到系统相册 -Taro.openVideoEditor 打开视频编辑器 -Taro.getVideoInfo 获取视频详细信息 -Taro.createVideoContext 创建 video 上下文 VideoContext 对象 -Taro.compressVideo 压缩视频接口 -Taro.chooseVideo 拍摄视频或从手机相册中选视频 -Taro.chooseMedia 拍摄或从手机相册中选择图片或视频 - -#### VideoContext - -VideoContext.exitBackgroundPlayback 退出后台音频播放模式 -VideoContext.exitFullScreen 退出全屏 -VideoContext.exitPictureInPicture 退出小窗，该方法可在任意页面调用 -VideoContext.hideStatusBar 隐藏状态栏，仅在iOS全屏下有效 -VideoContext.pause 暂停视频 -VideoContext.play 播放视频 -VideoContext.playbackRate 设置倍速播放 -VideoContext.requestBackgroundPlayback 进入后台音频播放模式 -VideoContext.requestFullScreen 进入全屏 -VideoContext.seek 跳转到指定位置 -VideoContext.sendDanmu 发送弹幕 -VideoContext.showStatusBar 显示状态栏，仅在iOS全屏下有效 -VideoContext.stop 停止视频 - -### 音频 - -Taro.stopVoice 结束播放语音 -Taro.setInnerAudioOption 设置 InnerAudioContext 的播放选项 -Taro.playVoice 开始播放语音 -Taro.pauseVoice 暂停正在播放的语音 -Taro.getAvailableAudioSources 获取当前支持的音频输入源 -Taro.createWebAudioContext 创建 WebAudio 上下文 -Taro.createMediaAudioPlayer 创建媒体音频播放器对象 MediaAudioPlayer 对象，可用于播放视频解码器 VideoDecoder 输出的音频 -Taro.createInnerAudioContext 创建内部 audio 上下文 InnerAudioContext 对象 -Taro.createAudioContext 创建 audio 上下文 AudioContext 对象 - -#### AudioBuffer - -AudioBuffer.copyFromChannel 从AudioBuffer的指定频道复制到数组终端 -AudioBuffer.copyToChannel 从指定数组复制样本到audioBuffer的特定通道 -AudioBuffer.getChannelData 返回一个 Float32Array，包含了带有频道的PCM数据，由频道参数定义（有0代表第一个频道） - -#### AudioContext - -AudioContext.pause 暂停音频 -AudioContext.play 播放音频 -AudioContext.seek 跳转到指定位置 -AudioContext.setSrc 设置音频地址 - -#### InnerAudioContext - -InnerAudioContext.destroy 销毁当前实例 -InnerAudioContext.offCanplay 取消监听音频进入可以播放状态的事件 -InnerAudioContext.offEnded 取消监听音频自然播放至结束的事件 -InnerAudioContext.offError 取消监听音频播放错误事件 -InnerAudioContext.offPause 取消监听音频暂停事件 -InnerAudioContext.offPlay 取消监听音频播放事件 -InnerAudioContext.offSeeked 取消监听音频完成跳转操作的事件 -InnerAudioContext.offSeeking 取消监听音频进行跳转操作的事件 -InnerAudioContext.offStop 取消监听音频停止事件 -InnerAudioContext.offTimeUpdate 取消监听音频播放进度更新事件 -InnerAudioContext.offWaiting 取消监听音频加载中事件 -InnerAudioContext.onCanplay 监听音频进入可以播放状态的事件 -InnerAudioContext.onEnded 监听音频自然播放至结束的事件 -InnerAudioContext.onError 监听音频播放错误事件 -InnerAudioContext.onPause 监听音频暂停事件 -InnerAudioContext.onPlay 监听音频播放事件 -InnerAudioContext.onSeeked 监听音频完成跳转操作的事件 -InnerAudioContext.onSeeking 监听音频进行跳转操作的事件 -InnerAudioContext.onStop 监听音频停止事件 -InnerAudioContext.onTimeUpdate 监听音频播放进度更新事件 -InnerAudioContext.onWaiting 监听音频加载中事件 -InnerAudioContext.pause 暂停 -InnerAudioContext.play 播放 -InnerAudioContext.seek 跳转到指定位置 -InnerAudioContext.stop 停止 - -#### MediaAudioPlayer - -MediaAudioPlayer.addAudioSource 添加音频源 -MediaAudioPlayer.destroy 销毁播放器 -MediaAudioPlayer.removeAudioSource 移除音频源 -MediaAudioPlayer.start 启动播放器 -MediaAudioPlayer.stop 停止播放器 - -#### WebAudioContext - -WebAudioContext.close 关闭WebAudioContext -WebAudioContext.createBiquadFilter 创建一个BiquadFilterNode -WebAudioContext.createBuffer 创建一个AudioBuffer，代表着一段驻留在内存中的短音频 -WebAudioContext.createBufferSource 创建一个BufferSourceNode实例，通过AudioBuffer对象来播放音频数据 -WebAudioContext.createChannelMerger 创建一个ChannelMergerNode -WebAudioContext.createChannelSplitter 创建一个ChannelSplitterNode -WebAudioContext.createConstantSource 创建一个ConstantSourceNode -WebAudioContext.createDelay 创建一个DelayNode -WebAudioContext.createDynamicsCompressor 创建一个DynamicsCompressorNode -WebAudioContext.createGain 创建一个GainNode -WebAudioContext.createIIRFilter 创建一个IIRFilterNode -WebAudioContext.createOscillator 创建一个OscillatorNode -WebAudioContext.createPanner 创建一个PannerNode -WebAudioContext.createPeriodicWave 创建一个PeriodicWaveNode -WebAudioContext.createScriptProcessor 创建一个ScriptProcessorNode -WebAudioContext.createWaveShaper 创建一个WaveShaperNode -WebAudioContext.decodeAudioData 异步解码一段资源为AudioBuffer -WebAudioContext.resume 同步恢复已经被暂停的WebAudioContext上下文 -WebAudioContext.suspend 同步暂停WebAudioContext上下文 - -#### WebAudioContextNode 一类音频处理模块，不同的Node具备不同的功能，如GainNode(音量调整)等 - -### 背景音频 - -Taro.stopBackgroundAudio 停止播放音乐 -Taro.seekBackgroundAudio 控制音乐播放进度 -Taro.playBackgroundAudio 使用后台播放器播放音乐 -Taro.pauseBackgroundAudio 暂停播放音乐 -Taro.onBackgroundAudioStop 监听音乐停止事件 -Taro.onBackgroundAudioPlay 监听音乐播放事件 -Taro.onBackgroundAudioPause 监听音乐暂停事件 -Taro.getBackgroundAudioPlayerState 获取后台音乐播放状态 -Taro.getBackgroundAudioManager 获取全局唯一的背景音频管理器 - -#### BackgroundAudioManager - -BackgroundAudioManager.onCanplay 监听背景音频进入可播放状态事件 -BackgroundAudioManager.onEnded 监听背景音频自然播放结束事件 -BackgroundAudioManager.onError 监听背景音频播放错误事件 -BackgroundAudioManager.onNext 监听用户在系统音乐播放面板点击下一曲事件（仅iOS） -BackgroundAudioManager.onPause 监听背景音频暂停事件 -BackgroundAudioManager.onPlay 监听背景音频播放事件 -BackgroundAudioManager.onPrev 监听用户在系统音乐播放面板点击上一曲事件（仅iOS） -BackgroundAudioManager.onSeeked 监听背景音频完成跳转操作事件 -BackgroundAudioManager.onSeeking 监听背景音频开始跳转操作事件 -BackgroundAudioManager.onStop 监听背景音频停止事件 -BackgroundAudioManager.onTimeUpdate 监听背景音频播放进度更新事件，只有小程序在前台时会回调 -BackgroundAudioManager.onWaiting 监听音频加载中事件 -BackgroundAudioManager.pause 暂停音乐 -BackgroundAudioManager.play 播放音乐 -BackgroundAudioManager.seek 跳转到指定位置 -BackgroundAudioManager.stop 停止音乐 - -### 实时音视频 - -Taro.createLivePusherContext 创建 live-pusher 上下文 LivePusherContext 对象 -Taro.createLivePlayerContext 创建 live-player 上下文 LivePlayerContext 对象 - -#### LivePlayerContext - -LivePlayerContext.exitFullScreen 退出全屏 -LivePlayerContext.exitPictureInPicture 退出小窗，该方法可在任意页面调用 -LivePlayerContext.mute 静音 -LivePlayerContext.pause 暂停 -LivePlayerContext.play 播放 -LivePlayerContext.requestFullScreen 进入全屏 -LivePlayerContext.requestPictureInPicture 进入小窗 -LivePlayerContext.resume 恢复 -LivePlayerContext.snapshot 截图 -LivePlayerContext.stop 停止 - -#### LivePusherContext - -LivePusherContext.pause 暂停推流 -LivePusherContext.pauseBGM 暂停背景音 -LivePusherContext.playBGM 播放背景音 -LivePusherContext.resume 恢复推流 -LivePusherContext.resumeBGM 恢复背景音 -LivePusherContext.sendMessage 发送SEI消息 -LivePusherContext.setBGMVolume 设置背景音音量 -LivePusherContext.setMICVolume 设置麦克风音量 -LivePusherContext.snapshot 快照 -LivePusherContext.start 开始推流，同时开启摄像头预览 -LivePusherContext.startPreview 开启摄像头预览 -LivePusherContext.stop 停止推流，同时停止摄像头预览 -LivePusherContext.stopBGM 停止背景音 -LivePusherContext.stopPreview 关闭摄像头预览 -LivePusherContext.switchCamera 切换前后摄像头 -LivePusherContext.toggleTorch 切换手电筒 - -### 录音 - -Taro.stopRecord 停止录音 -Taro.startRecord 开始录音 -Taro.getRecorderManager 获取全局唯一的录音管理器 RecorderManager - -#### RecorderManager - -RecorderManager.onError 监听录音错误事件 -RecorderManager.onFrameRecorded 监听已录制完指定帧大小的文件事件 -RecorderManager.onInterruptionBegin 监听录音因为受到系统占用而被中断开始事件 -RecorderManager.onInterruptionEnd 监听录音中断结束事件 -RecorderManager.onPause 监听录音暂停事件 -RecorderManager.onResume 监听录音继续事件 -RecorderManager.onStart 监听录音开始事件 -RecorderManager.onStop 监听录音结束事件 -RecorderManager.pause 暂停录音 -RecorderManager.resume 继续录音 -RecorderManager.start 开始录音 -RecorderManager.stop 停止录音 - -### 相机 - -Taro.createCameraContext 创建 camera 上下文 CameraContext 对象 - -#### CameraContext - -CameraContext.onCameraFrame 获取 Camera 实时帧数据 -CameraContext.setZoom 设置缩放级别 -CameraContext.startRecord 开始录像 -CameraContext.stopRecord 结束录像 -CameraContext.takePhoto 拍摄照片 - -#### CameraFrameListener - -CameraFrameListener.start 开始监听帧数据 -CameraFrameListener.stop 停止监听帧数据 - -### 富文本 - -#### EditorContext - -EditorContext.blur 编辑器失焦，同时收起键盘 -EditorContext.clear 清空编辑器内容 -EditorContext.format 修改样式 -EditorContext.getContents 获取编辑器内容 -EditorContext.getSelectionText 获取编辑器已选区域内的纯文本内容 -EditorContext.insertDivider 插入分割线 -EditorContext.insertImage 插入图片 -EditorContext.insertText 覆盖当前选区，设置一段文本 -EditorContext.redo 恢复 -EditorContext.removeFormat 清除当前选区的样式 -EditorContext.scrollIntoView 使得编辑器光标处滚动到窗口可视区域内 -EditorContext.setContents 初始化编辑器内容，html和delta同时存在时仅delta生效 -EditorContext.undo 撤销 - -### 音视频合成 - -Taro.createMediaContainer 创建音视频处理容器，最终可将容器中的轨道合成一个视频 - -#### MediaContainer - -MediaContainer.addTrack 将音频或视频轨道添加到容器 -MediaContainer.destroy 将容器销毁，释放资源 -MediaContainer.export 将容器内的轨道合并并导出视频文件 -MediaContainer.extractDataSource 将传入的视频源分离轨道 -MediaContainer.removeTrack 将音频或视频轨道从容器中移除 - -#### MediaTrack 可通过 MediaContainer.extractDataSource 返回 - -### 实时语音 - -Taro.updateVoIPChatMuteConfig 更新实时语音静音设置 -Taro.subscribeVoIPVideoMembers 订阅视频画面成员 -Taro.setEnable1v1Chat 开启双人通话 -Taro.onVoIPVideoMembersChanged 监听实时语音通话成员视频状态变化事件 -Taro.onVoIPChatStateChanged 监听房间状态变化事件 -Taro.onVoIPChatSpeakersChanged 监听实时语音通话成员通话状态变化事件 -Taro.onVoIPChatMembersChanged 监听实时语音通话成员在线状态变化事件 -Taro.onVoIPChatInterrupted 监听被动断开实时语音通话事件 -Taro.offVoIPVideoMembersChanged 取消监听实时语音通话成员视频状态变化事件 -Taro.offVoIPChatStateChanged 取消监听房间状态变化事件 -Taro.offVoIPChatMembersChanged 取消监听实时语音通话成员在线状态变化事件 -Taro.offVoIPChatInterrupted 取消监听被动断开实时语音通话事件 -Taro.joinVoIPChat 加入 (创建) 实时语音通话，更多信息可见 实时语音指南 -Taro.exitVoIPChat 退出（销毁）实时语音通话 - -### 画面录制器 - -Taro.createMediaRecorder 创建 WebGL 画面录制器，可逐帧录制在 WebGL 上渲染的画面并导出视频文件 - -#### MediaRecorder - -MediaRecorder.destroy 销毁录制器 -MediaRecorder.off 取消监听录制事件 -MediaRecorder.on 注册监听录制事件的回调函数 -MediaRecorder.pause 暂停录制 -MediaRecorder.requestFrame 请求下一帧录制，在 callback 里完成一帧渲染后开始录制当前帧 -MediaRecorder.resume 恢复录制 -MediaRecorder.start 开始录制 -MediaRecorder.stop 结束录制 - -### 视频解码器 - -Taro.createVideoDecoder 创建视频解码器，可逐帧获取解码后的数据 - -#### VideoDecoder - -VideoDecoder.getFrameData 获取下一帧的解码数据 -VideoDecoder.off 取消监听录制事件 -VideoDecoder.on 注册监听录制事件的回调函数 -VideoDecoder.remove 移除解码器 -VideoDecoder.seek 跳到某个时间点解码 -VideoDecoder.start 开始解码 -VideoDecoder.stop 停止解码 - -## 位置 - -Taro.stopLocationUpdate 关闭监听实时位置变化，前后台都停止消息接收 -Taro.startLocationUpdateBackground 开启小程序进入前后台时均接收位置消息，需引导用户开启授权 -Taro.startLocationUpdate 开启小程序进入前台时接收位置消息 -Taro.openLocation 使用微信内置地图查看位置 -Taro.onLocationChangeError 监听持续定位接口返回失败时触发 -Taro.onLocationChange 监听实时地理位置变化事件，需结合 Taro.startLocationUpdateBackground、wx.startLocationUpdate使用 -Taro.offLocationChangeError 取消监听持续定位接口返回失败时触发 -Taro.offLocationChange 取消监听实时地理位置变化事件 -Taro.getLocation 获取当前的地理位置、速度 -Taro.choosePoi 打开POI列表选择位置，支持模糊定位（精确到市）和精确定位混选 -Taro.chooseLocation 打开地图选择位置 - -## 文件 - -Taro.saveFileToDisk 保存文件系统的文件到用户磁盘，仅在 PC 端支持 -Taro.saveFile 保存文件到本地 -Taro.removeSavedFile 删除本地缓存文件 -Taro.openDocument 新开页面打开文档 -Taro.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 -Taro.getSavedFileInfo 获取本地文件的文件信息 -Taro.getFileSystemManager 获取全局唯一的文件管理器 -Taro.getFileInfo 获取文件信息 - -### FileSystemManager - -FileSystemManager.access 判断文件/目录是否存在 -FileSystemManager.accessSync FileSystemManager.access 的同步版本 -FileSystemManager.appendFile 在文件结尾追加内容 -FileSystemManager.appendFileSync FileSystemManager.appendFile 的同步版本 -FileSystemManager.close 关闭文件 -FileSystemManager.closeSync 同步关闭文件 -FileSystemManager.copyFile 复制文件 -FileSystemManager.copyFileSync FileSystemManager.copyFile 的同步版本 -FileSystemManager.fstat 获取文件的状态信息 -FileSystemManager.fstatSync 同步获取文件的状态信息 -FileSystemManager.ftruncate 对文件内容进行截断操作 -FileSystemManager.ftruncateSync 对文件内容进行截断操作 -FileSystemManager.getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 -FileSystemManager.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 -FileSystemManager.mkdir 创建目录 -FileSystemManager.mkdirSync FileSystemManager.mkdir 的同步版本 -FileSystemManager.open 打开文件，返回文件描述符 -FileSystemManager.openSync 同步打开文件，返回文件描述符 -FileSystemManager.read 读文件 -FileSystemManager.readCompressedFile 读取指定压缩类型的本地文件内容 -FileSystemManager.readCompressedFileSync 同步读取指定压缩类型的本地文件内容 -FileSystemManager.readdir 读取目录内文件列表 -FileSystemManager.readdirSync FileSystemManager.readdir 的同步版本 -FileSystemManager.readFile 读取本地文件内容 -FileSystemManager.readFileSync FileSystemManager.readFile 的同步版本 -FileSystemManager.readSync 读文件 -FileSystemManager.readZipEntry 读取压缩包内的文件 -FileSystemManager.removeSavedFile 删除该小程序下已保存的本地缓存文件 -FileSystemManager.rename 重命名文件 -FileSystemManager.renameSync FileSystemManager.rename 的同步版本 -FileSystemManager.rmdir 删除目录 -FileSystemManager.rmdirSync FileSystemManager.rmdir 的同步版本 -FileSystemManager.saveFile 保存临时文件到本地 -FileSystemManager.saveFileSync FileSystemManager.saveFile 的同步版本 -FileSystemManager.stat 获取文件 Stats 对象 -FileSystemManager.statSync FileSystemManager.stat 的同步版本 -FileSystemManager.truncate 对文件内容进行截断操作 -FileSystemManager.truncateSync 对文件内容进行截断操作 (truncate 的同步版本) -FileSystemManager.unlink 删除文件 -FileSystemManager.unlinkSync FileSystemManager.unlink 的同步版本 -FileSystemManager.unzip 解压文件 -FileSystemManager.write 写入文件 -FileSystemManager.writeFile 写文件 -FileSystemManager.writeFileSync FileSystemManager.writeFile 的同步版本 -FileSystemManager.writeSync 同步写入文件 - -### ReadResult 文件读取结果 - -### Stats - -Stats.isDirectory 判断当前文件是否一个目录 -Stats.isFile 判断当前文件是否一个普通文件 - -### WriteResult 文件写入结果 - -## 开放接口 - -### 登录 - -Taro.pluginLogin 该接口仅在小程序插件中可调用，调用接口获得插件用户标志凭证（code） -Taro.login 调用接口获取登录凭证（code） -Taro.checkSession 检查登录态是否过期 - -### 帐号信息 - -Taro.getAccountInfoSync 获取当前帐号信息 - -### 用户信息 - -Taro.getUserProfile 获取用户信息 -Taro.getUserInfo 获取用户信息 -UserInfo 用户信息 - -### 授权 - -Taro.authorizeForMiniProgram 仅小程序插件中能调用该接口，用法同 Taro.authorize -Taro.authorize 提前向用户发起授权请求 - -### 设置 - -Taro.openSetting 调起客户端小程序设置界面，返回用户设置的操作结果 -Taro.getSetting 获取用户的当前设置 -AuthSetting 用户授权设置信息，详情参考权限 -SubscriptionsSetting 订阅消息设置 - -### 收货地址 - -Taro.chooseAddress 获取用户收货地址 - -### 卡券 - -Taro.openCard 查看微信卡包中的卡券 -Taro.addCard 批量添加卡券 - -### 发票 - -Taro.chooseInvoiceTitle 选择用户的发票抬头 -Taro.chooseInvoice 选择用户已有的发票 - -### 生物认证 - -Taro.startSoterAuthentication 开始 SOTER 生物认证 -Taro.checkIsSupportSoterAuthentication 获取本机支持的 SOTER 生物认证方式 -Taro.checkIsSoterEnrolledInDevice 获取设备内是否录入如指纹等生物信息的接口 - -### 微信运动 - -Taro.shareToWeRun 分享数据到微信运动 -Taro.getWeRunData 获取用户过去三十天微信运动步数 - -### 订阅消息 - -Taro.requestSubscribeMessage 调起客户端小程序订阅消息界面，返回用户订阅消息的操作结果 -Taro.requestSubscribeDeviceMessage 订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息 - -### 微信红包 - -Taro.showRedPackage 拉取h5领取红包封面页 - -### 收藏 - -Taro.addVideoToFavorites 收藏视频 -Taro.addFileToFavorites 收藏文件 - -### 车牌 - -Taro.chooseLicensePlate 选择车牌号 - -### 视频号 - -Taro.reserveChannelsLive 预约视频号直播 -Taro.openChannelsUserProfile 打开视频号主页 -Taro.openChannelsLive 打开视频号直播 -Taro.openChannelsEvent 打开视频号活动页 -Taro.openChannelsActivity 打开视频号视频 -Taro.getChannelsLiveNoticeInfo 获取视频号直播预告信息 -Taro.getChannelsLiveInfo 获取视频号直播信息 - -### 微信群 - -Taro.getGroupEnterInfo 获取微信群聊场景下的小程序启动信息 - -### 微信客服 - -Taro.openCustomerServiceChat 打开微信客服 - -## 设备 - -### 蓝牙-通用 - -Taro.stopBluetoothDevicesDiscovery 停止搜寻附近的蓝牙外围设备 -Taro.startBluetoothDevicesDiscovery 开始搜寻附近的蓝牙外围设备 -Taro.openBluetoothAdapter 初始化蓝牙模块 -Taro.onBluetoothDeviceFound 监听搜索到新设备的事件 -Taro.onBluetoothAdapterStateChange 监听蓝牙适配器状态变化事件 -Taro.offBluetoothDeviceFound 取消监听寻找到新设备的事件 -Taro.offBluetoothAdapterStateChange 取消监听蓝牙适配器状态变化事件 -Taro.makeBluetoothPair 蓝牙配对接口，仅安卓支持 -Taro.isBluetoothDevicePaired 查询蓝牙设备是否配对，仅安卓支持 -Taro.getConnectedBluetoothDevices 根据主服务 UUID 获取已连接的蓝牙设备 -Taro.getBluetoothDevices 获取在蓝牙模块生效期间所有搜索到的蓝牙设备 -Taro.getBluetoothAdapterState 获取本机蓝牙适配器状态 -Taro.closeBluetoothAdapter 关闭蓝牙模块 - -### 蓝牙-低功耗中心设备 - -Taro.writeBLECharacteristicValue 向蓝牙低功耗设备特征值中写入二进制数据 -Taro.setBLEMTU 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU) -Taro.readBLECharacteristicValue 读取蓝牙低功耗设备特征值的二进制数据 -Taro.onBLEMTUChange 监听蓝牙低功耗的最大传输单元变化事件（仅安卓触发） -Taro.onBLEConnectionStateChange 监听蓝牙低功耗连接状态的改变事件 -Taro.onBLECharacteristicValueChange 监听蓝牙低功耗设备的特征值变化事件 -Taro.offBLEMTUChange 取消监听蓝牙低功耗的最大传输单元变化事件 -Taro.offBLEConnectionStateChange 取消监听蓝牙低功耗连接状态的改变事件 -Taro.offBLECharacteristicValueChange 取消监听蓝牙低功耗设备的特征值变化事件 -Taro.notifyBLECharacteristicValueChange 启用蓝牙低功耗设备特征值变化时的 notify 功能，订阅特征 -Taro.getBLEMTU 获取蓝牙低功耗的最大传输单元 -Taro.getBLEDeviceServices 获取蓝牙低功耗设备所有服务 (service) -Taro.getBLEDeviceRSSI 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI) -Taro.getBLEDeviceCharacteristics 获取蓝牙低功耗设备某个服务中所有特征 (characteristic) -Taro.createBLEConnection 连接蓝牙低功耗设备 -Taro.closeBLEConnection 断开与蓝牙低功耗设备的连接 - -### 蓝牙-低功耗外围设备 - -Taro.onBLEPeripheralConnectionStateChanged 监听当前外围设备被连接或断开连接事件 -Taro.offBLEPeripheralConnectionStateChanged 取消监听当前外围设备被连接或断开连接事件 -Taro.createBLEPeripheralServer 建立本地作为蓝牙低功耗外围设备的服务端，可创建多个 - -#### BLEPeripheralServer - -BLEPeripheralServer.addService 添加服务 -BLEPeripheralServer.close 关闭当前服务端 -BLEPeripheralServer.offCharacteristicReadRequest 取消监听已连接的设备请求读当前外围设备的特征值事件 -BLEPeripheralServer.offCharacteristicSubscribed 取消监听特征订阅事件 -BLEPeripheralServer.offCharacteristicUnsubscribed 取消监听取消特征订阅事件 -BLEPeripheralServer.offCharacteristicWriteRequest 取消监听已连接的设备请求写当前外围设备的特征值事件 -BLEPeripheralServer.onCharacteristicReadRequest 监听已连接的设备请求读当前外围设备的特征值事件 -BLEPeripheralServer.onCharacteristicSubscribed 监听特征订阅事件，仅 iOS 支持 -BLEPeripheralServer.onCharacteristicUnsubscribed 监听取消特征订阅事件，仅 iOS 支持 -BLEPeripheralServer.onCharacteristicWriteRequest 监听已连接的设备请求写当前外围设备的特征值事件 -BLEPeripheralServer.removeService 移除服务 -BLEPeripheralServer.startAdvertising 开始广播本地创建的外围设备 -BLEPeripheralServer.stopAdvertising 停止广播 -BLEPeripheralServer.writeCharacteristicValue 往指定特征写入二进制数据值，并通知已连接的主机，从机的特征值已发生变化，该接口会处理是走回包还是走订阅 - -### 蓝牙-信标(Beacon) - -Taro.stopBeaconDiscovery 停止搜索附近的 Beacon 设备 -Taro.startBeaconDiscovery 开始搜索附近的 Beacon 设备 -Taro.onBeaconUpdate 监听 Beacon 设备更新事件，仅能注册一个监听 -Taro.onBeaconServiceChange 监听 Beacon 服务状态变化事件，仅能注册一个监听 -Taro.offBeaconUpdate 取消监听 Beacon 设备更新事件 -Taro.offBeaconServiceChange 取消监听 Beacon 服务状态变化事件 -Taro.getBeacons 获取所有已搜索到的 Beacon 设备 -BeaconInfo Beacon 设备 - -### NFC - -Taro.stopHCE 关闭 NFC 模块 -Taro.startHCE 初始化 NFC 模块 -Taro.sendHCEMessage 发送 NFC 消息 -Taro.onHCEMessage 监听接收 NFC 设备消息事件，仅能注册一个监听 -Taro.offHCEMessage 接收 NFC 设备消息事件，取消事件监听 -Taro.getNFCAdapter 获取 NFC 实例 -Taro.getHCEState 判断当前设备是否支持 HCE 能力 - -#### IsoDep - -IsoDep.close 断开连接 -IsoDep.connect 连接 NFC 标签 -IsoDep.getHistoricalBytes 获取复位信息 -IsoDep.getMaxTransceiveLength 获取最大传输长度 -IsoDep.isConnected 检查是否已连接 -IsoDep.setTimeout 设置超时时间 -IsoDep.transceive 发送数据 - -#### MifareClassic - -MifareClassic.close 断开连接 -MifareClassic.connect 连接 NFC 标签 -MifareClassic.getMaxTransceiveLength 获取最大传输长度 -MifareClassic.isConnected 检查是否已连接 -MifareClassic.setTimeout 设置超时时间 -MifareClassic.transceive 发送数据 - -#### MifareUltralight - -MifareUltralight.close 断开连接 -MifareUltralight.connect 连接 NFC 标签 -MifareUltralight.getMaxTransceiveLength 获取最大传输长度 -MifareUltralight.isConnected 检查是否已连接 -MifareUltralight.setTimeout 设置超时时间 -MifareUltralight.transceive 发送数据 - -#### Ndef - -Ndef.close 断开连接 -Ndef.connect 连接 NFC 标签 -Ndef.isConnected 检查是否已连接 -Ndef.offNdefMessage 取消监听 Ndef 消息 -Ndef.onNdefMessage 监听 Ndef 消息 -Ndef.setTimeout 设置超时时间 -Ndef.writeNdefMessage 重写 Ndef 标签内容 - -#### NfcA - -NfcA.close 断开连接 -NfcA.connect 连接 NFC 标签 -NfcA.getAtqa 获取ATQA信息 -NfcA.getMaxTransceiveLength 获取最大传输长度 -NfcA.getSak 获取SAK信息 -NfcA.isConnected 检查是否已连接 -NfcA.setTimeout 设置超时时间 -NfcA.transceive 发送数据 - -#### NFCAdapter - -NFCAdapter.getIsoDep 获取IsoDep实例，实例支持ISO-DEP (ISO 14443-4)标准的读写 -NFCAdapter.getMifareClassic 获取MifareClassic实例，实例支持MIFARE Classic标签的读写 -NFCAdapter.getMifareUltralight 获取MifareUltralight实例，实例支持MIFARE Ultralight标签的读写 -NFCAdapter.getNdef 获取Ndef实例，实例支持对NDEF格式的NFC标签上的NDEF数据的读写 -NFCAdapter.getNfcA 获取NfcA实例，实例支持NFC-A (ISO 14443-3A)标准的读写 -NFCAdapter.getNfcB 获取NfcB实例，实例支持NFC-B (ISO 14443-3B)标准的读写 -NFCAdapter.getNfcF 获取NfcF实例，实例支持NFC-F (JIS 6319-4)标准的读写 -NFCAdapter.getNfcV 获取NfcV实例，实例支持NFC-V (ISO 15693)标准的读写 -NFCAdapter.offDiscovered 取消监听 NFC Tag -NFCAdapter.onDiscovered 监听 NFC Tag -NFCAdapter.startDiscovery -NFCAdapter.stopDiscovery - -#### NfcB - -NfcB.close 断开连接 -NfcB.connect 连接 NFC 标签 -NfcB.getMaxTransceiveLength 获取最大传输长度 -NfcB.isConnected 检查是否已连接 -NfcB.setTimeout 设置超时时间 -NfcB.transceive 发送数据 - -#### NfcF - -NfcF.close 断开连接 -NfcF.connect 连接 NFC 标签 -NfcF.getMaxTransceiveLength 获取最大传输长度 -NfcF.isConnected 检查是否已连接 -NfcF.setTimeout 设置超时时间 -NfcF.transceive 发送数据 - -#### NfcV - -NfcV.close 断开连接 -NfcV.connect 连接 NFC 标签 -NfcV.getMaxTransceiveLength 获取最大传输长度 -NfcV.isConnected 检查是否已连接 -NfcV.setTimeout 设置超时时间 -NfcV.transceive 发送数据 - -### Wi-Fi - -Taro.stopWifi 关闭 Wi-Fi 模块 -Taro.startWifi 初始化 Wi-Fi 模块 -Taro.setWifiList 设置 wifiList 中 AP 的相关信息 -Taro.onWifiConnectedWithPartialInfo 监听连接上 Wi-Fi 的事件 -Taro.onWifiConnected 监听连接上 Wi-Fi 的事件 -Taro.onGetWifiList 监听获取到 Wi-Fi 列表数据事件 -Taro.offWifiConnectedWithPartialInfo 取消监听连接上 Wi-Fi 的事件 -Taro.offWifiConnected 取消监听连接上 Wi-Fi 的事件 -Taro.offGetWifiList 取消监听获取到 Wi-Fi 列表数据事件 -Taro.getWifiList 请求获取 Wi-Fi 列表 -Taro.getConnectedWifi 获取已连接中的 Wi-Fi 信息 -Taro.connectWifi 连接 Wi-Fi -WifiInfo Wifi 信息 - -### 日历 - -Taro.addPhoneRepeatCalendar 向系统日历添加重复事件 -Taro.addPhoneCalendar 向系统日历添加事件 - -### 联系人 - -Taro.chooseContact 拉起手机通讯录，选择联系人 -Taro.addPhoneContact 添加手机通讯录联系人 - -### 无障碍 - -Taro.checkIsOpenAccessibility 检测是否开启视觉无障碍功能 - -### 电量 - -Taro.getBatteryInfoSync Taro.getBatteryInfo 的同步版本 -Taro.getBatteryInfo 获取设备电量 - -### 剪贴板 - -Taro.setClipboardData 设置系统剪贴板的内容 -Taro.getClipboardData 获取系统剪贴板的内容 - -### 网络 - -Taro.onNetworkWeakChange 监听弱网状态变化事件 -Taro.onNetworkStatusChange 监听网络状态变化事件 -Taro.offNetworkWeakChange 取消监听弱网状态变化事件 -Taro.offNetworkStatusChange 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 -Taro.getNetworkType 获取网络类型 -Taro.getLocalIPAddress 获取局域网IP地址 - -### 加密 - -Taro.getRandomValues 获取密码学安全随机数 - -### 屏幕 - -Taro.setVisualEffectOnCapture 设置截屏/录屏时屏幕表现，仅支持在 Android 端调用 -Taro.setScreenBrightness 设置屏幕亮度 -Taro.setKeepScreenOn 设置是否保持常亮状态 -Taro.onUserCaptureScreen 监听用户主动截屏事件 -Taro.offUserCaptureScreen 用户主动截屏事件 -Taro.getScreenBrightness 获取屏幕亮度 - -### 键盘 - -Taro.onKeyboardHeightChange 监听键盘高度变化 -Taro.offKeyboardHeightChange 取消监听键盘高度变化事件 -Taro.hideKeyboard 在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘 -Taro.getSelectedTextRange 在input、textarea等focus之后，获取输入框的光标位置 - -### 电话 - -Taro.makePhoneCall 拨打电话 - -### 加速计 - -Taro.stopAccelerometer 停止监听加速度数据 -Taro.startAccelerometer 开始监听加速度数据 -Taro.onAccelerometerChange 监听加速度数据事件 -Taro.offAccelerometerChange 取消监听加速度数据事件，参数为空，则取消所有的事件监听 - -### 罗盘 - -Taro.stopCompass 停止监听罗盘数据 -Taro.startCompass 开始监听罗盘数据 -Taro.onCompassChange 监听罗盘数据变化事件 -Taro.offCompassChange 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听 - -### 设备方向 - -Taro.stopDeviceMotionListening 停止监听设备方向的变化 -Taro.startDeviceMotionListening 开始监听设备方向的变化 -Taro.onDeviceMotionChange 监听设备方向变化事件 -Taro.offDeviceMotionChange 取消监听设备方向变化事件，参数为空，则取消所有的事件监听 - -### 陀螺仪 - -Taro.stopGyroscope 停止监听陀螺仪数据 -Taro.startGyroscope 开始监听陀螺仪数据 -Taro.onGyroscopeChange 监听陀螺仪数据变化事件 -Taro.offGyroscopeChange 取消监听陀螺仪数据变化事件 - -### 内存 - -Taro.onMemoryWarning 监听内存不足告警事件 -Taro.offMemoryWarning 取消监听内存不足告警事件 - -### 扫码 - -Taro.scanCode 调起客户端扫码界面进行扫码 - -### 振动 - -Taro.vibrateShort 使手机发生较短时间的振动（15 ms） -Taro.vibrateLong 使手机发生较长时间的振动（400 ms) - -## AI - -### 视觉算法 - -Taro.isVKSupport 判断支持版本 -Taro.createVKSession 创建 vision kit 会话对象 - -### VKAnchor anchor 对象，只有 v2 版本支持 - -#### VKCamera - -VKCamera.getProjectionMatrix 获取投影矩阵 - -#### VKFrame - -VKFrame.getCameraTexture 获取当前帧纹理，目前只支持 YUV 纹理 -VKFrame.getDisplayTransform 获取纹理调整矩阵 - -#### VKSession - -VKSession.cancelAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求 -VKSession.destroy 销毁会话 -VKSession.getVKFrame 获取帧对象，每调用一次都会触发一次帧分析过程 -VKSession.hitTest 触摸检测，v1 版本只支持单平面（即 hitTest 生成一次平面后，后续 hitTest 均不会再生成平面，而是以之前生成的平面为基础进行检测） -VKSession.off 取消监听会话事件 -VKSession.on 监听会话事件 -VKSession.requestAnimationFrame 在下次进行重绘时执行 -VKSession.start 开启会话 -VKSession.stop 停止会话 - -### 人脸识别 - -Taro.stopFaceDetect 停止人脸识别 -Taro.initFaceDetect 初始化人脸识别 -Taro.faceDetect 人脸识别，使用前需要通过 Taro.initFaceDetect 进行一次初始化，推荐使用相机接口返回的帧数据 - -## Worker - -Taro.createWorker 创建一个 Worker 线程 - -### Worker - -Worker.onMessage 监听主线程/Worker 线程向当前线程发送的消息的事件 -Worker.onProcessKilled 监听 worker线程被系统回收事件（当iOS系统资源紧张时，worker线程存在被系统回收的可能，开发者可监听此事件并重新创建一个worker） -Worker.postMessage 向主线程/Worker 线程发送的消息 -Worker.terminate 结束当前 Worker 线程 - -## WXML - -Taro.createSelectorQuery 返回一个 SelectorQuery 对象实例 -Taro.createIntersectionObserver 创建并返回一个 IntersectionObserver 对象实例 - -### IntersectionObserver - -IntersectionObserver.disconnect 停止监听 -IntersectionObserver.observe 指定目标节点并开始监听相交状态变化情况 -IntersectionObserver.relativeTo 使用选择器指定一个节点，作为参照区域之一 -IntersectionObserver.relativeToViewport 指定页面显示区域作为参照区域之一 - -### MediaQueryObserver - -MediaQueryObserver.disconnect 停止监听 -MediaQueryObserver.observe 开始监听页面 media query 变化情况 - -### NodesRef - -NodesRef.boundingClientRect 添加节点的布局位置的查询请求 -NodesRef.context 添加节点的 Context 对象查询请求 -NodesRef.fields 获取节点的相关信息 -NodesRef.node 获取 Node 节点实例 -NodesRef.scrollOffset 添加节点的滚动位置查询请求 - -### SelectorQuery - -SelectorQuery.exec 执行所有的请求 -SelectorQuery.in 将选择器的选取范围更改为自定义组件 component 内 -SelectorQuery.select 在当前页面下选择第一个匹配选择器 selector 的节点 -SelectorQuery.selectAll 在当前页面下选择匹配选择器 selector 的所有节点 -SelectorQuery.selectViewport 选择显示区域 - -## 第三方平台 - -Taro.getExtConfigSync Taro.getExtConfig 的同步版本 -Taro.getExtConfig 获取第三方平台自定义的数据字段 - -## 广告 - -Taro.createRewardedVideoAd 创建激励视频广告组件 -Taro.createInterstitialAd 创建插屏广告组件 - -### InterstitialAd - -InterstitialAd.destroy 销毁插屏广告实例 -InterstitialAd.load 加载插屏广告 -InterstitialAd.offClose 取消监听插屏广告关闭事件 -InterstitialAd.offError 取消监听插屏错误事件 -InterstitialAd.offLoad 取消监听插屏广告加载事件 -InterstitialAd.onClose 监听插屏广告关闭事件 -InterstitialAd.onError 监听插屏错误事件 -InterstitialAd.onLoad 监听插屏广告加载事件 -InterstitialAd.show 显示插屏广告 - -### RewardedVideoAd - -RewardedVideoAd.destroy 销毁激励视频广告实例 -RewardedVideoAd.load 加载激励视频广告 -RewardedVideoAd.offClose 取消监听用户点击 关闭广告 按钮的事件 -RewardedVideoAd.offError 取消监听激励视频错误事件 -RewardedVideoAd.offLoad 取消监听激励视频广告加载事件 -RewardedVideoAd.onClose 监听用户点击 关闭广告 按钮的事件 -RewardedVideoAd.onError 监听激励视频错误事件 -RewardedVideoAd.onLoad 监听激励视频广告加载事件 -RewardedVideoAd.show 显示激励视频广告 diff --git a/versioned_docs/version-4.x/apis/location/chooseLocation.md b/versioned_docs/version-4.x/apis/location/chooseLocation.md deleted file mode 100644 index 9d2eb3e00e3b..000000000000 --- a/versioned_docs/version-4.x/apis/location/chooseLocation.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Taro.chooseLocation(option) -sidebar_label: chooseLocation ---- - -打开地图选择位置。 - -`chooseLocation` api功能是依赖于腾讯位置服务，所以需要使用 api 密钥。如果您没有，可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| latitude | `number` | 否 | 目标地纬度 | -| longitude | `number` | 否 | 目标地经度 | -| mapOpts | `Record` | 否 | 地图选点组件参数
API 支持度: h5
h5: 仅支持 H5 使用
[参考地址](https://lbs.qq.com/webApi/component/componentGuide/componentPicker) | -| title | `string` | 否 | 页面显示标题
API 支持度: alipay
alipay: 安卓默认值为 位置，iOS、IDE 默认值为 你在哪里?
[参考地址](https://opendocs.alipay.com/mini/api/location?pathHash=951b46a1) | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| address | `string` | 是 | 详细地址 | -| latitude | `number` | 是 | 纬度，浮点数，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 | -| longitude | `number` | 是 | 经度，浮点数，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 | -| name | `string` | 是 | 位置名称 | -| adCode | `number` | 否 | 区县代码
API 支持度: alipay | -| adName | `string` | 否 | 区县名称
API 支持度: alipay | -| cityCode | `string` | 否 | 城市代码
API 支持度: alipay | -| cityName | `string` | 否 | 城市名称
API 支持度: alipay | -| provinceCode | `number` | 否 | 省份代码
API 支持度: alipay | -| provinceName | `string` | 否 | 省份名称
API 支持度: alipay | -| errMsg | `string` | 是 | 调用结果 | - -## 示例代码 - -```tsx -// config/index.js - -// 获得 api 密钥后，您需要将它填入项目的常量配置`defineConstants.LOCATION_APIKEY`中： -const config = { - defineConstants: { - LOCATION_APIKEY: JSON.stringify('XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX') - }, - // ... -} -``` diff --git a/versioned_docs/version-4.x/apis/location/choosePoi.md b/versioned_docs/version-4.x/apis/location/choosePoi.md deleted file mode 100644 index ef2c90c6611d..000000000000 --- a/versioned_docs/version-4.x/apis/location/choosePoi.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.choosePoi(option) -sidebar_label: choosePoi ---- - -打开POI列表选择位置，支持模糊定位（精确到市）和精确定位混选。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.choosePoi.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `number` | 选择城市时，值为 1，选择精确位置时，值为 2 | -| city | `number` | 城市名称 | -| name | `string` | 位置名称 | -| address | `string` | 详细地址 | -| latitude | `number` | 纬度，浮点数，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 | -| longitude | `number` | 经度，浮点数，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 | diff --git a/versioned_docs/version-4.x/apis/location/getFuzzyLocation.md b/versioned_docs/version-4.x/apis/location/getFuzzyLocation.md deleted file mode 100644 index 62ae6433586c..000000000000 --- a/versioned_docs/version-4.x/apis/location/getFuzzyLocation.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.getFuzzyLocation(option) -sidebar_label: getFuzzyLocation ---- - -获取当前的模糊地理位置 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getFuzzyLocation.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| type | `keyof Type` | 否 | wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### Type - -| 参数 | 说明 | -| --- | --- | -| wgs84 | 返回 gps 坐标 | -| gcj02 | 返回 gcj02 坐标 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| latitude | `number` | 纬度，范围为 -90~90，负数表示南纬 | -| longitude | `number` | 经度，范围为 -180~180，负数表示西经 | - -## 示例代码 - -```tsx -Taro.getFuzzyLocation({ - type: 'wgs84', - success (res) { - const latitude = res.latitude - const longitude = res.longitude - }, -}) -``` diff --git a/versioned_docs/version-4.x/apis/location/getLocation.md b/versioned_docs/version-4.x/apis/location/getLocation.md deleted file mode 100644 index 8a42c7980414..000000000000 --- a/versioned_docs/version-4.x/apis/location/getLocation.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Taro.getLocation(option) -sidebar_label: getLocation ---- - -获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。开启高精度定位，接口耗时会增加，可指定 highAccuracyExpireTime 作为超时时间。 - -**注意** -- 工具中定位模拟使用IP定位，可能会有一定误差。且工具目前仅支持 gcj02 坐标。 -- 使用第三方服务进行逆地址解析时，请确认第三方服务默认的坐标系，正确进行坐标转换。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| altitude | `boolean` | `false` | 否 | 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| highAccuracyExpireTime | `number` | | 否 | 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 | -| isHighAccuracy | `boolean` | `false` | 否 | 开启高精度定位 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| type | `string` | `"wgs84"` | 否 | wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标 | -| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性，其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息，iOS14/Android12 及以上如果没有精确定位权限，会弹出精确定位授权弹框
API 支持度: swan | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| accuracy | `number` | 是 | 位置的精确度 | -| altitude | `number` | 是 | 高度，单位 m | -| horizontalAccuracy | `number` | 是 | 水平精度，单位 m | -| latitude | `number` | 是 | 纬度，范围为 -90~90，负数表示南纬 | -| longitude | `number` | 是 | 经度，范围为 -180~180，负数表示西经 | -| speed | `number` | 是 | 速度，单位 m/s | -| verticalAccuracy | `number` | 是 | 垂直精度，单位 m（Android 无法获取，返回 0） | -| street | `string` | 否 | 城市名称
API 支持度: swan | -| cityCode | `string` | 否 | 国家代码
API 支持度: swan | -| city | `string` | 否 | 城市名称
API 支持度: swan, tt | -| country | `string` | 否 | 国家
API 支持度: swan | -| countryCode | `string` | 否 | 国家代码
API 支持度: swan | -| province | `string` | 否 | 省份
API 支持度: swan | -| streetNumber | `string` | 否 | 街道号码
API 支持度: swan | -| district | `string` | 否 | 区
API 支持度: swan | -| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan | -| errMsg | `string` | 是 | 调用结果 | - -## 示例代码 - - ```tsx -Taro.getLocation({ - type: 'wgs84', - success: function (res) { - const latitude = res.latitude - const longitude = res.longitude - const speed = res.speed - const accuracy = res.accuracy - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/location/offLocationChange.md b/versioned_docs/version-4.x/apis/location/offLocationChange.md deleted file mode 100644 index 2346bf155d14..000000000000 --- a/versioned_docs/version-4.x/apis/location/offLocationChange.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offLocationChange(callback) -sidebar_label: offLocationChange ---- - -取消监听实时地理位置变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 实时地理位置变化事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/location/offLocationChangeError.md b/versioned_docs/version-4.x/apis/location/offLocationChangeError.md deleted file mode 100644 index c0cacc35fbff..000000000000 --- a/versioned_docs/version-4.x/apis/location/offLocationChangeError.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offLocationChangeError(callback) -sidebar_label: offLocationChangeError ---- - -取消监听持续定位接口返回失败时触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChangeError.html) - -## 类型 - -```tsx -(callback?: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听持续定位接口返回失败时触发的回调函数 | diff --git a/versioned_docs/version-4.x/apis/location/onLocationChange.md b/versioned_docs/version-4.x/apis/location/onLocationChange.md deleted file mode 100644 index e409fa055f20..000000000000 --- a/versioned_docs/version-4.x/apis/location/onLocationChange.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Taro.onLocationChange(callback) -sidebar_label: onLocationChange ---- - -监听实时地理位置变化事件，需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 实时地理位置变化事件的回调函数 | - -### Callback - -实时地理位置变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| accuracy | `number` | 是 | 位置的精确度 | -| altitude | `number` | 是 | 高度，单位 m | -| horizontalAccuracy | `number` | 是 | 水平精度，单位 m | -| latitude | `number` | 是 | 纬度，范围为 -90~90，负数表示南纬 | -| longitude | `number` | 是 | 经度，范围为 -180~180，负数表示西经 | -| speed | `number` | 是 | 速度，单位 m/s | -| verticalAccuracy | `number` | 是 | 垂直精度，单位 m（Android 无法获取，返回 0） | -| street | `string` | 否 | 街道名称
API 支持度: swan | -| cityCode | `string` | 否 | 城市编码
API 支持度: swan | -| city | `string` | 否 | 城市名称
API 支持度: swan, tt
tt: iOS 不支持 | -| country | `string` | 否 | 国家
API 支持度: swan | -| countryCode | `string` | 否 | 国家代码
API 支持度: swan | -| province | `string` | 否 | 省份
API 支持度: swan | -| streetNumber | `string` | 否 | 街道号码
API 支持度: swan | -| district | `string` | 否 | 区
API 支持度: swan | -| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan | - -## 示例代码 - -```tsx -const _locationChangeFn = function (res) { - console.log('location change', res) -} -Taro.onLocationChange(_locationChangeFn) -Taro.offLocationChange(_locationChangeFn) -``` diff --git a/versioned_docs/version-4.x/apis/location/onLocationChangeError.md b/versioned_docs/version-4.x/apis/location/onLocationChangeError.md deleted file mode 100644 index ceea7f0ef57a..000000000000 --- a/versioned_docs/version-4.x/apis/location/onLocationChangeError.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.onLocationChangeError(callback) -sidebar_label: onLocationChangeError ---- - -监听持续定位接口返回失败时触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChangeError.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听持续定位接口返回失败时触发的回调函数 | - -### Callback - -监听持续定位接口返回失败时触发的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| errCode | `number` | 是 | 错误码 | -| errMsg | `string` | 否 | 错误信息
API 支持度: tt
tt: 最低支持版本 2.48.0 | diff --git a/versioned_docs/version-4.x/apis/location/openLocation.md b/versioned_docs/version-4.x/apis/location/openLocation.md deleted file mode 100644 index 8a3c69ecb3ce..000000000000 --- a/versioned_docs/version-4.x/apis/location/openLocation.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.openLocation(option) -sidebar_label: openLocation ---- - -使用微信内置地图查看位置 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.openLocation.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| latitude | `number` | 是 | 纬度，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 | -| longitude | `number` | 是 | 经度，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 | -| scale | `number` | 否 | 缩放比例
weapp: 范围 5~18，默认值18
alipay: 范围 3~19，默认值15 | -| name | `string` | 否 | 位置名 | -| address | `string` | 否 | 地址的详细说明 | -| ignoredApps | `any[]` | 否 | 定义在拉起的地图 App 面板中需要被屏蔽的地图类 App
API 支持度: swan | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.getLocation({ - type: 'gcj02', //返回可以用于 Taro.openLocation的经纬度 - success: function (res) { - const latitude = res.latitude - const longitude = res.longitude - Taro.openLocation({ - latitude, - longitude, - scale: 18 - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/location/startLocationUpdate.md b/versioned_docs/version-4.x/apis/location/startLocationUpdate.md deleted file mode 100644 index eacbbf7ee09c..000000000000 --- a/versioned_docs/version-4.x/apis/location/startLocationUpdate.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.startLocationUpdate(option) -sidebar_label: startLocationUpdate ---- - -开启小程序进入前台时接收位置消息 - -**注意** -- 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标，gcj02 返回可用于 wx.openLocation 的坐标 | -| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性，其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息，iOS14/Android12 及以上如果没有精确定位权限，会弹出精确定位授权弹框
API 支持度: swan | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/location/startLocationUpdateBackground.md b/versioned_docs/version-4.x/apis/location/startLocationUpdateBackground.md deleted file mode 100644 index cb94cf604d9e..000000000000 --- a/versioned_docs/version-4.x/apis/location/startLocationUpdateBackground.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.startLocationUpdateBackground(option) -sidebar_label: startLocationUpdateBackground ---- - -开启小程序进入前后台时均接收位置消息，需引导用户开启[授权](../open-api/authorize/authorize.md#后台定位)。授权以后，小程序在运行中或进入后台均可接受位置消息变化。 - -**注意** -- 安卓微信7.0.6版本，iOS 7.0.5版本起支持该接口 -- 需在app.json中配置requiredBackgroundModes: ['location']后使用 -- 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdateBackground.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标，gcj02 返回可用于 wx.openLocation 的坐标 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/location/stopLocationUpdate.md b/versioned_docs/version-4.x/apis/location/stopLocationUpdate.md deleted file mode 100644 index 47b9f49c965b..000000000000 --- a/versioned_docs/version-4.x/apis/location/stopLocationUpdate.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.stopLocationUpdate(option) -sidebar_label: stopLocationUpdate ---- - -关闭监听实时位置变化，前后台都停止消息接收 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/audio/AudioBuffer.md b/versioned_docs/version-4.x/apis/media/audio/AudioBuffer.md deleted file mode 100644 index dbcc20325370..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/AudioBuffer.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: AudioBuffer -sidebar_label: AudioBuffer ---- - -AudioBuffer 接口表示存在内存里的一段短小的音频资源，利用 [WebAudioContext.decodeAudioData](./WebAudioContext#decodeaudiodata) 方法从一个音频文件构建，或者利用 [AudioContext.createBuffer](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/(AudioContext.createBuffer).html) 从原始数据构建。把音频放入 AudioBuffer 后，可以传入到一个 AudioBufferSourceNode 进行播放。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioBuffer.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sampleRate | `number` | 存储在缓存区的PCM数据的采样率（单位为sample/s) | -| length | `number` | 返回存储在缓存区的PCM数据的采样帧率 | -| duration | `number` | 返回存储在缓存区的PCM数据的时长（单位为秒） | -| numberOfChannels | `number` | 储存在缓存区的PCM数据的通道数 | - -### getChannelData - -返回一个 Float32Array，包含了带有频道的PCM数据，由频道参数定义（有0代表第一个频道） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioBuffer.getChannelData.html) - -```tsx -(channel: number) => Float32Array -``` - -| 参数 | 类型 | -| --- | --- | -| channel | `number` | - -#### 示例代码 - -```tsx -const audioCtx = Taro.createWebAudioContext() -const myArrayBuffer = audioCtx.createBuffer(2, frameCount, audioCtx.sampleRate); -const nowBuffering = myArrayBuffer.getChannelData(channel); -``` - -### copyFromChannel - -从 AudioBuffer 的指定频道复制到数组终端。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioBuffer.copyFromChannel.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const audioCtx = Taro.createWebAudioContext() -const audioBuffer = audioCtx.createFromAudioFile({ - filePath:'/pages/res/bgm.mp3', // 静态资源 - mixToMono:true, - sampleRate:44100 -}); -const channels = audioBuffer.numberOfChannels -const anotherArray = new Float32Array(frameCount); -const rate = audioBuffer.sampleRate -const startOffSet = 0 -const endOffset = rate * 3; -const newAudioBuffer = audioCtx.createBuffer(channels,endOffset - startOffset,rate) -const offset = 0 - -for (let channel = 0; channel < channels; channel++) { - audioBuffer.copyFromChannel(anotherArray, channel, startOffset); - newAudioBuffer.copyToChannel(anotherArray, channel, offset); -} -``` - -### copyToChannel - -从指定数组复制样本到 audioBuffer 的特定通道 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioBuffer.copyToChannel.html) - -```tsx -(source: Float32Array, channelNumber: number, startInChannel: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| source | `Float32Array` | 需要复制的源数组 | -| channelNumber | `number` | 需要复制到的目的通道号 | -| startInChannel | `number` | 复制偏移数据量 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| AudioBuffer | ✔️ | | | | -| AudioBuffer.getChannelData | ✔️ | | | | -| AudioBuffer.copyFromChannel | ✔️ | | | | -| AudioBuffer.copyToChannel | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/audio/AudioContext.md b/versioned_docs/version-4.x/apis/media/audio/AudioContext.md deleted file mode 100644 index 5982f4609eaf..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/AudioContext.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: AudioContext -sidebar_label: AudioContext ---- - -`AudioContext` 实例，可通过 `Taro.createAudioContext` 获取。 - -`AudioContext` 通过 `id` 跟一个 `audio` 组件绑定，操作对应的 audio 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.html) - -## 方法 - -### pause - -暂停音频。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.pause.html) - -```tsx -() => void -``` - -### play - -播放音频。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.play.html) - -```tsx -() => void -``` - -### seek - -跳转到指定位置。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.seek.html) - -```tsx -(position: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| position | `number` | 跳转位置，单位 s | - -### setSrc - -设置音频地址 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.setSrc.html) - -```tsx -(src: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| src | `string` | 音频地址 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| AudioContext | ✔️ | | | | -| AudioContext.pause | ✔️ | | | | -| AudioContext.play | ✔️ | | | | -| AudioContext.seek | ✔️ | | | | -| AudioContext.setSrc | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/audio/InnerAudioContext.md b/versioned_docs/version-4.x/apis/media/audio/InnerAudioContext.md deleted file mode 100644 index 77fb7a40866e..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/InnerAudioContext.md +++ /dev/null @@ -1,560 +0,0 @@ ---- -title: InnerAudioContext -sidebar_label: InnerAudioContext ---- - -InnerAudioContext 实例，可通过 [Taro.createInnerAudioContext](./createInnerAudioContext) 接口获取实例。 - -**支持格式** - -| 格式 | iOS | Android | -| ---- | ---- | ------- | -| flac | x | √ | -| m4a | √ | √ | -| ogg | x | √ | -| ape | x | √ | -| amr | x | √ | -| wma | x | √ | -| wav | √ | √ | -| mp3 | √ | √ | -| mp4 | x | √ | -| aac | √ | √ | -| aiff | √ | x | -| caf | √ | x | - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/InnerAudioContext.html) - -## 方法 - -| 参数 | 类型 | 默认值 | 只读 | 必填 | 说明 | -| --- | --- | :---: | :---: | :---: | --- | -| src | `string` | | 否 | 是 | 音频资源的地址，用于直接播放。 | -| startTime | `number` | `0` | 否 | 是 | 开始播放的位置（单位：s） | -| autoplay | `boolean` | `false` | 否 | 是 | 是否自动开始播放 | -| loop | `boolean` | `false` | 否 | 是 | 是否循环播放 | -| obeyMuteSwitch | `boolean` | `true` | 否 | 是 | 是否遵循系统静音开关。当此参数为 `false` 时，即使用户打开了静音开关，也能继续发出声音。从 2.3.0 版本开始此参数不生效，使用 [Taro.setInnerAudioOption](/docs/apis/media/audio/setInnerAudioOption) 接口统一设置。 | -| volume | `number` | `1` | 否 | 是 | 音量。范围 0~1。 | -| playbackRate | `number` | `1` | 否 | 是 | 播放速度。范围 0.5-2.0。 | -| duration | `number` | | 是 | 是 | 当前音频的长度（单位 s）。只有在当前有合法的 src 时返回 | -| currentTime | `number` | | 是 | 是 | 当前音频的播放位置（单位 s）。只有在当前有合法的 src 时返回，时间保留小数点后 6 位 | -| paused | `boolean` | | 是 | 是 | 当前是是否暂停或停止状态 | -| buffered | `number` | | 是 | 是 | 音频缓冲的时间点，仅保证当前播放时间点到此时间点内容已缓冲 | -| referrerPolicy | `string` | | 否 | 否 | origin: 发送完整的 referrer; no-referrer: 不发送 | - -### play - -播放 - -支持情况： - -```tsx -() => void -``` - -### pause - -暂停 - -支持情况： - -```tsx -() => void -``` - -### stop - -停止 - -支持情况： - -```tsx -() => void -``` - -### seek - -跳转到指定位置，单位 s - -支持情况： - -```tsx -(position: number) => void -``` - -| 参数 | 类型 | -| --- | --- | -| position | `number` | - -### destroy - -销毁当前实例 - -支持情况： - -```tsx -() => void -``` - -### onCanplay - -音频进入可以播放状态，但不保证后面可以流畅播放 - -支持情况： - -```tsx -(callback?: OnCanplayCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCanplayCallback` | - -### onPlay - -音频播放事件 - -支持情况： - -```tsx -(callback?: OnPlayCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnPlayCallback` | - -### onPause - -音频暂停事件 - -支持情况： - -```tsx -(callback?: OnPauseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnPauseCallback` | - -### onStop - -音频停止事件 - -支持情况： - -```tsx -(callback?: OnStopCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnStopCallback` | - -### onEnded - -音频自然播放结束事件 - -支持情况： - -```tsx -(callback?: OnEndedCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnEndedCallback` | - -### onTimeUpdate - -音频播放进度更新事件 - -支持情况： - -```tsx -(callback?: OnTimeUpdateCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnTimeUpdateCallback` | - -### onError - -音频播放错误事件 - -支持情况： - -```tsx -(callback?: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### onWaiting - -音频加载中事件，当音频因为数据不足，需要停下来加载时会触发 - -支持情况： - -```tsx -(callback?: OnWaitingCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnWaitingCallback` | - -### onSeeking - -音频进行 seek 操作事件 - -支持情况： - -```tsx -(callback?: OnSeekingCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnSeekingCallback` | - -### onSeeked - -音频完成 seek 操作事件 - -支持情况： - -```tsx -(callback?: OnSeekedCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnSeekedCallback` | - -### offCanplay - -取消监听 canplay 事件 - -支持情况： - -```tsx -(callback?: OnCanplayCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnCanplayCallback` | - -### offPlay - -取消监听 play 事件 - -支持情况： - -```tsx -(callback?: OnPlayCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnPlayCallback` | - -### offPause - -取消监听 pause 事件 - -支持情况： - -```tsx -(callback?: OnPauseCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnPauseCallback` | - -### offStop - -取消监听 stop 事件 - -支持情况： - -```tsx -(callback?: OnStopCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnStopCallback` | - -### offEnded - -取消监听 ended 事件 - -支持情况： - -```tsx -(callback?: OnEndedCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnEndedCallback` | - -### offTimeUpdate - -取消监听 timeUpdate 事件 - -支持情况： - -```tsx -(callback?: OnTimeUpdateCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnTimeUpdateCallback` | - -### offError - -取消监听 error 事件 - -支持情况： - -```tsx -(callback?: OnErrorCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnErrorCallback` | - -### offWaiting - -取消监听 waiting 事件 - -支持情况： - -```tsx -(callback?: OnWaitingCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnWaitingCallback` | - -### offSeeking - -取消监听 seeking 事件 - -支持情况： - -```tsx -(callback?: OnSeekingCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnSeekingCallback` | - -### offSeeked - -取消监听 seeked 事件 - -支持情况： - -```tsx -(callback?: OnSeekedCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `OnSeekedCallback` | - -## 参数 - -### onErrorDetail - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | `number` | 错误码 | -| errMsg | `string` | 错误信息 | - -### onErrorDetailErrCode - -| 参数 | 说明 | -| --- | --- | -| 10001 | 系统错误 | -| 10002 | 网络错误 | -| 10003 | 文件错误 | -| 10004 | 格式错误 | -| -1 | 未知错误 | - -### OnCanplayCallback - -音频进入可以播放状态事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnPlayCallback - -音频播放事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnPauseCallback - -音频暂停事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnStopCallback - -音频停止事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnEndedCallback - -音频自然播放结束事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnTimeUpdateCallback - -音频播放进度更新事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnErrorCallback - -音频播放错误事件的回调函数 - -```tsx -(res: onErrorDetail) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `onErrorDetail` | - -### OnWaitingCallback - -音频加载中事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnSeekingCallback - -音频进行 seek 操作事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -### OnSeekedCallback - -音频完成 seek 操作事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | - -## 示例代码 - -```tsx -const innerAudioContext = Taro.createInnerAudioContext() -innerAudioContext.autoplay = true -innerAudioContext.src = 'https://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46' -innerAudioContext.onPlay(() => { - console.log('开始播放') -}) -innerAudioContext.onError((res) => { - console.log(res.errMsg) - console.log(res.errCode) -}) -``` - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| InnerAudioContext.play | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.pause | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.stop | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.seek | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.destroy | ✔️ | ✔️ | | | -| InnerAudioContext.onCanplay | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onPlay | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onPause | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onStop | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onEnded | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onTimeUpdate | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onError | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onWaiting | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onSeeking | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.onSeeked | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offCanplay | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offPlay | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offPause | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offStop | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offEnded | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offTimeUpdate | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offError | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offWaiting | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offSeeking | ✔️ | ✔️ | ✔️ | | -| InnerAudioContext.offSeeked | ✔️ | ✔️ | ✔️ | | diff --git a/versioned_docs/version-4.x/apis/media/audio/MediaAudioPlayer.md b/versioned_docs/version-4.x/apis/media/audio/MediaAudioPlayer.md deleted file mode 100644 index 2dcbb8b65023..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/MediaAudioPlayer.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: MediaAudioPlayer -sidebar_label: MediaAudioPlayer ---- - -MediaAudioPlayer 实例，可通过 [Taro.createMediaAudioPlayer](./createMediaAudioPlayer) 接口获取实例。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.html) - -## 方法 - -| 参数 | 类型 | 默认值 | 说明 | -| --- | --- | :---: | --- | -| volume | `number` | `1` | 音量。范围 0~1 | - -### start - -启动播放器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.start.html) - -```tsx -() => Promise -``` - -### addAudioSource - -添加音频源 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.addAudioSource.html) - -```tsx -(source: VideoDecoder) => Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| source | `VideoDecoder` | 视频解码器实例。作为音频源添加到音频播放器中 | - -### removeAudioSource - -移除音频源 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.removeAudioSource.html) - -```tsx -(source: VideoDecoder) => Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| source | `VideoDecoder` | 视频解码器实例 | - -### stop - -停止播放器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.stop.html) - -```tsx -() => Promise -``` - -### destroy - -销毁播放器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/MediaAudioPlayer.destroy.html) - -```tsx -() => Promise -``` - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MediaAudioPlayer | ✔️ | | | | -| MediaAudioPlayer.start | ✔️ | | | | -| MediaAudioPlayer.addAudioSource | ✔️ | | | | -| MediaAudioPlayer.removeAudioSource | ✔️ | | | | -| MediaAudioPlayer.stop | ✔️ | | | | -| MediaAudioPlayer.destroy | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/audio/WebAudioContext.md b/versioned_docs/version-4.x/apis/media/audio/WebAudioContext.md deleted file mode 100644 index c81ae17f9365..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/WebAudioContext.md +++ /dev/null @@ -1,443 +0,0 @@ ---- -title: WebAudioContext -sidebar_label: WebAudioContext ---- - -WebAudioContext 实例，通过 [Taro.createWebAudioContext](./createWebAudioContext) 接口获取该实例。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| state | `string` | 当前 WebAudio 上下文的状态。

可能的值如下：suspended（暂停）、running（正在运行）、closed（已关闭）。
需要注意的是，不要在 audioContext close 后再访问 state 属性 | -| onstatechange | `() => void` | 可写属性，开发者可以对该属性设置一个监听函数，当 WebAudio 状态改变的时候，会触发开发者设置的监听函数。 | -| currentTime | `number` | 获取当前上下文的时间戳。 | -| destination | `WebAudioContextNode` | 当前上下文的最终目标节点，一般是音频渲染设备。 | -| listener | `AudioListener` | 空间音频监听器。 | -| sampleRate | `number` | 采样率，通常在 8000-96000 之间，通常 44100hz 的采样率最为常见。 | - -### close - -关闭WebAudioContext - -**注意事项** -同步关闭对应的 WebAudio 上下文。close 后会立即释放当前上下文的资源，**不要在 close 后再次访问 state 属性**。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.close.html) - -```tsx -() => Promise -``` - -#### 示例代码 - -```tsx -const audioCtx = Taro.createWebAudioContext() -audioCtx.close().then(() => { - console.log(audioCtx.state) // bad case：不应该在close后再访问state -}) -``` - -### resume - -同步恢复已经被暂停的 WebAudioContext 上下文 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.resume.html) - -```tsx -() => Promise -``` - -### suspend - -同步暂停 WebAudioContext 上下文 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.suspend.html) - -```tsx -() => Promise -``` - -### createIIRFilter - -创建一个 IIRFilterNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createIIRFilter.html) - -```tsx -(feedforward: number[], feedback: number[]) => IIRFilterNode -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| feedforward | `number[]` | 一个浮点值数组，指定IIR滤波器传递函数的前馈(分子)系数。 | -| feedback | `number[]` | 一个浮点值数组，指定IIR滤波器传递函数的反馈(分母)系数。 | - -#### 示例代码 - -```tsx -let lowPassCoefs = [ - { - frequency: 200, - feedforward: [0.00020298, 0.0004059599, 0.00020298], - feedback: [1.0126964558, -1.9991880801, 0.9873035442] - }, - { - frequency: 500, - feedforward: [0.0012681742, 0.0025363483, 0.0012681742], - feedback: [1.0317185917, -1.9949273033, 0.9682814083] - }, - { - frequency: 1000, - feedforward: [0.0050662636, 0.0101325272, 0.0050662636], - feedback: [1.0632762845, -1.9797349456, 0.9367237155] - }, - { - frequency: 5000, - feedforward: [0.1215955842, 0.2431911684, 0.1215955842], - feedback: [1.2912769759, -1.5136176632, 0.7087230241] - } -] - -const feedForward = lowPassCoefs[filterNumber].feedforward -const feedBack = lowPassCoefs[filterNumber].feedback -const iirFilter = audioContext.createIIRFilter(feedForward, feedBack) -``` - -### createWaveShaper - -创建一个 WaveShaperNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createWaveShaper.html) - -```tsx -() => WaveShaperNode -``` - -### createConstantSource - -创建一个 ConstantSourceNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createConstantSource.html) - -```tsx -() => ConstantSourceNode -``` - -### createOscillator - -创建一个 OscillatorNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createOscillator.html) - -```tsx -() => OscillatorNode -``` - -### createGain - -创建一个 GainNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createGain.html) - -```tsx -() => GainNode -``` - -### createPeriodicWave - -创建一个 PeriodicWaveNode - -**注意** -`real` 和 `imag` 数组必须拥有一样的长度，否则抛出错误 - -```tsx -const real = new Float32Array(2) -const imag = new Float32Array(2) -real[0] = 0 -imag[0] = 0 -real[1] = 1 -imag[1] = 0 - -const waveNode = audioContext.createPeriodicWave(real, imag, {disableNormalization: true}) -``` - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createPeriodicWave.html) - -```tsx -(real: Float32Array, imag: Float32Array, constraints: Constraints) => PeriodicWave -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| real | `Float32Array` | 一组余弦项(传统上是A项) | -| imag | `Float32Array` | 一组余弦项(传统上是A项) | -| constraints | `Constraints` | 一个字典对象，它指定是否应该禁用规范化(默认启用规范化) | - -### createBiquadFilter - -创建一个BiquadFilterNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createBiquadFilter.html) - -```tsx -() => BiquadFilterNode -``` - -### createBufferSource - -创建一个 BufferSourceNode 实例，通过 AudioBuffer 对象来播放音频数据。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createBufferSource.html) - -```tsx -() => AudioBufferSourceNode -``` - -### createChannelMerger - -创建一个ChannelMergerNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createChannelMerger.html) - -```tsx -(numberOfInputs: number) => ChannelMergerNode -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| numberOfInputs | `number` | 输出流中需要保持的输入流的个数 | - -### createChannelSplitter - -创建一个ChannelSplitterNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createChannelSplitter.html) - -```tsx -(numberOfOutputs: number) => ChannelSplitterNode -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| numberOfOutputs | `number` | 要分别输出的输入音频流中的通道数 | - -### createDelay - -创建一个DelayNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createDelay.html) - -```tsx -(maxDelayTime: number) => DelayNode -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| maxDelayTime | `number` | 最大延迟时间 | - -#### 示例代码 - -```tsx -let audioCtx = Taro.createWebAudioContext() -const delayNode = audioCtx.createDelay(5) -``` - -### createDynamicsCompressor - -创建一个DynamicsCompressorNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createDynamicsCompressor.html) - -```tsx -() => DynamicsCompressorNode -``` - -#### 示例代码 - -```tsx -let audioCtx = Taro.createWebAudioContext() -let compressor = audioCtx.createDynamicsCompressor() - -compressor.threshold.value = -50 -compressor.knee.value = 40 -compressor.ratio.value = 12 -compressor.attack.value = 0 -compressor.release.value = 0.25 -``` - -### createScriptProcessor - -创建一个ScriptProcessorNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createScriptProcessor.html) - -```tsx -(bufferSize: number, numberOfInputChannels: number, numberOfOutputChannels: number) => ScriptProcessorNode -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bufferSize | `number` | 缓冲区大小，以样本帧为单位 | -| numberOfInputChannels | `number` | 用于指定输入 node 的声道的数量 | -| numberOfOutputChannels | `number` | 用于指定输出 node 的声道的数量 | - -#### 示例代码 - -```tsx -let audioCtx = Taro.createWebAudioContext() -const sampleSize = 4096 -audioContext.createScriptProcessor(sampleSize, 1, 1) -``` - -### createPanner - -创建一个PannerNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createPanner.html) - -```tsx -() => PannerNode -``` - -### createBuffer - -创建一个AudioBuffer，代表着一段驻留在内存中的短音频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.createBuffer.html) - -```tsx -(numOfChannels: number, length: number, sampleRate: number) => AudioBuffer -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| numOfChannels | `number` | 定义了 buffer 中包含的声频通道数量的整数 | -| length | `number` | 代表 buffer 中的样本帧数的整数 | -| sampleRate | `number` | 线性音频样本的采样率，即每一秒包含的关键帧的个数 | - -#### 示例代码 - -```tsx -const audioCtx = Taro.createWebAudioContext() -const channels = 2, frameCount = audioCtx.sampleRate * 2.0 -const myArrayBuffer = audioCtx.createBuffer(channels, frameCount, audioCtx.sampleRate) -``` - -### decodeAudioData - -异步解码一段资源为AudioBuffer。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContext.decodeAudioData.html) - -```tsx -() => AudioBuffer -``` - -#### 示例代码 - -```tsx -Taro.request({ - url: url, // 音频 url - responseType: 'arraybuffer', - success: res => { - audioCtx.decodeAudioData(res.data, buffer => { - console.log(buffer) - }, err => { - console.error('decodeAudioData fail', err) - }) - } -}) -``` - -## 参数 - -### createPeriodicWave - -#### Constraints - -字典对象 - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| disableNormalization | `boolean` | `false` | 否 | 如果指定为 true 则禁用标准化 | - -## 示例代码 - -监听状态 - -```tsx -const audioCtx = Taro.createWebAudioContext() -audioCtx.onstatechange = () => { - console.log(ctx.state) -} -setTimeout(audioCtx.suspend, 1000) -setTimeout(audioCtx.resume, 2000) -``` - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| WebAudioContext | ✔️ | | | | -| WebAudioContext.close | ✔️ | | | | -| WebAudioContext.resume | ✔️ | | | | -| WebAudioContext.suspend | ✔️ | | | | -| WebAudioContext.createIIRFilter | ✔️ | | | | -| WebAudioContext.createWaveShaper | ✔️ | | | | -| WebAudioContext.createConstantSource | ✔️ | | | | -| WebAudioContext.createOscillator | ✔️ | | | | -| WebAudioContext.createGain | ✔️ | | | | -| WebAudioContext.createPeriodicWave | ✔️ | | | | -| WebAudioContext.createBiquadFilter | ✔️ | | | | -| WebAudioContext.createBufferSource | ✔️ | | | | -| WebAudioContext.createChannelMerger | ✔️ | | | | -| WebAudioContext.createChannelSplitter | ✔️ | | | | -| WebAudioContext.createDelay | ✔️ | | | | -| WebAudioContext.createDynamicsCompressor | ✔️ | | | | -| WebAudioContext.createScriptProcessor | ✔️ | | | | -| WebAudioContext.createPanner | ✔️ | | | | -| WebAudioContext.createBuffer | ✔️ | | | | -| WebAudioContext.decodeAudioData | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/audio/WebAudioContextNode.md b/versioned_docs/version-4.x/apis/media/audio/WebAudioContextNode.md deleted file mode 100644 index 30078292772b..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/WebAudioContextNode.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: WebAudioContextNode -sidebar_label: WebAudioContextNode ---- - -一类音频处理模块，不同的Node具备不同的功能，如GainNode(音量调整)等。一个 WebAudioContextNode 可以通过上下文来创建。 - -> 目前已经支持以下Node： IIRFilterNode WaveShaperNode ConstantSourceNode ChannelMergerNode OscillatorNode GainNode BiquadFilterNode PeriodicWaveNode BufferSourceNode ChannelSplitterNode ChannelMergerNode DelayNode DynamicsCompressorNode ScriptProcessorNode PannerNode - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/WebAudioContextNode.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| positionX | `number` | 右手笛卡尔坐标系中X轴的位置。 | -| positionY | `number` | 右手笛卡尔坐标系中Y轴的位置。 | -| positionZ | `number` | 右手笛卡尔坐标系中Z轴的位置。 | -| forwardX | `number` | 表示监听器的前向系统在同一笛卡尔坐标系中的水平位置，作为位置（位置x，位置和位置和位置）值。 | -| forwardY | `number` | 表示听众的前向方向在同一笛卡尔坐标系中作为位置（位置x，位置和位置和位置）值的垂直位置。 | -| forwardZ | `number` | 表示与position (positionX、positionY和positionZ)值在同一笛卡尔坐标系下的听者前进方向的纵向(前后)位置。 | -| upX | `number` | 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向前方向的水平位置。 | -| upY | `number` | 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向上方向的水平位置。 | -| upZ | `number` | 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向后方向的水平位置。 | - -### setOrientation - -设置监听器的方向 - -支持情况： - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `any[]` | - -### setPosition - -设置监听器的位置 - -支持情况： - -```tsx -(...args: any[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `any[]` | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| WebAudioContextNode | ✔️ | | | | -| WebAudioContextNode.setOrientation | ✔️ | | | | -| WebAudioContextNode.setPosition | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/audio/createAudioContext.md b/versioned_docs/version-4.x/apis/media/audio/createAudioContext.md deleted file mode 100644 index 0302c1a5295f..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/createAudioContext.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.createAudioContext(id, component) -sidebar_label: createAudioContext ---- - -创建 audio 上下文 AudioContext 对象。 -**注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](./createInnerAudioContext) 接口** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createAudioContext.html) - -## 类型 - -```tsx -(id: string, component?: TaroGeneral.IAnyObject) => AudioContext -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `string` | [audio](/docs/components/media/audio) 组件的 id | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 [audio](/docs/components/media/audio) 组件 | - -## 示例代码 - -```tsx -const audioCtx = Taro.createAudioContext('myAudio') -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/createInnerAudioContext.md b/versioned_docs/version-4.x/apis/media/audio/createInnerAudioContext.md deleted file mode 100644 index 6366a8161301..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/createInnerAudioContext.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.createInnerAudioContext() -sidebar_label: createInnerAudioContext ---- - -创建内部 audio 上下文 InnerAudioContext 对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createInnerAudioContext.html) - -## 类型 - -```tsx -() => InnerAudioContext -``` - -## 示例代码 - -```tsx -const innerAudioContext = Taro.createInnerAudioContext() -innerAudioContext.autoplay = true -innerAudioContext.src = 'https://storage.360buyimg.com/jdrd-blog/27.mp3' -innerAudioContext.onPlay(() => { - console.log('开始播放') -}) -innerAudioContext.onError((res) => { - console.log(res.errMsg) - console.log(res.errCode) -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/createMediaAudioPlayer.md b/versioned_docs/version-4.x/apis/media/audio/createMediaAudioPlayer.md deleted file mode 100644 index 0cce639fef34..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/createMediaAudioPlayer.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.createMediaAudioPlayer() -sidebar_label: createMediaAudioPlayer ---- - -创建媒体音频播放器对象 [MediaAudioPlayer](./MediaAudioPlayer) 对象，可用于播放视频解码器 [VideoDecoder](/docs/apis/media/video-decoder/VideoDecoder) 输出的音频 - -**注意事项** -- iOS 7.0.15 mediaAudioPlayer 播放网络视频资源会出现音频卡顿，本地视频没有这个问题，将下一个客户端版本修复。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createMediaAudioPlayer.html) - -## 类型 - -```tsx -() => MediaAudioPlayer -``` - -## 示例代码 - -```tsx -// 创建视频解码器，具体参数见 createVideoDecoder 文档 -const videoDecoder = Taro.createVideoDecoder() -// 创建媒体音频播放器 -const mediaAudioPlayer = Taro.createMediaAudioPlayer() -// 启动视频解码器 -videoDecoder.start() -// 启动播放器 -mediaAudioPlayer.start().then(() => { - // 添加播放器音频来源 - mediaAudioPlayer.addAudioSource(videoDecoder).then(res => { - videoDecoder.getFrameData() // 建议在 requestAnimationFrame 里获取每一帧视频数据 - console.log(res) - }) - - // 移除播放器音频来源 - mediaAudioPlayer.removeAudioSource(videoDecoder).then() - // 停止播放器 - mediaAudioPlayer.stop().then() - // 销毁播放器 - mediaAudioPlayer.destroy().then() - // 设置播放器音量 - mediaAudioPlayer.volume = 0.5 -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/createWebAudioContext.md b/versioned_docs/version-4.x/apis/media/audio/createWebAudioContext.md deleted file mode 100644 index 5b950d9d8e1d..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/createWebAudioContext.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Taro.createWebAudioContext() -sidebar_label: createWebAudioContext ---- - -创建 WebAudio 上下文。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createWebAudioContext.html) - -## 类型 - -```tsx -() => WebAudioContext -``` - -## 示例代码 - -一个简单的播放demo - -```tsx -const audioCtx = Taro.createWebAudioContext() - -const loadAudio = (url) => { - return new Promise((resolve) => { - Taro.request({ - url, - responseType: 'arraybuffer', - success: res => { - console.log('res.data', res.data) - audioCtx.decodeAudioData(res.data, buffer => { - resolve(buffer) - }, err => { - console.error('decodeAudioData fail', err) - reject() - }) - }, - fail: res => { - console.error('request fail', res) - reject() - } - }) - }) -} - -const play = () => { - loadAudio('xxx-test.mp3').then(buffer => { - const source = audioCtx.createBufferSource() - source.buffer = buffer - source.connect(audioCtx.destination) - source.start() - }).catch(() => { - console.log('fail') - }) -} - -play() -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/getAvailableAudioSources.md b/versioned_docs/version-4.x/apis/media/audio/getAvailableAudioSources.md deleted file mode 100644 index 7b8cc299d318..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/getAvailableAudioSources.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.getAvailableAudioSources(option) -sidebar_label: getAvailableAudioSources ---- - -获取当前支持的音频输入源 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.getAvailableAudioSources.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| audioSources | `(keyof audioSources)[]` | 支持的音频输入源列表，可在 [RecorderManager.start()](/docs/apis/media/recorder/RecorderManager#start)用。返回值定义参考 https://developer.android.com/reference/kotlin/android/media/MediaRecorder.AudioSource | -| errMsg | `string` | 调用结果 | - -### audioSources - -支持的音频输入源 - -| 参数 | 说明 | -| --- | --- | -| auto | 自动设置，默认使用手机麦克风，插上耳麦后自动切换使用耳机麦克风，所有平台适用 | -| buildInMic | 手机麦克风，仅限 iOS | -| headsetMic | 耳机麦克风，仅限 iOS | -| mic | 麦克风（没插耳麦时是手机麦克风，插耳麦时是耳机麦克风），仅限 Android | -| camcorder | 同 mic，适用于录制音视频内容，仅限 Android | -| voice_communication | 同 mic，适用于实时沟通，仅限 Android | -| voice_recognition | 同 mic，适用于语音识别，仅限 Android | diff --git a/versioned_docs/version-4.x/apis/media/audio/pauseVoice.md b/versioned_docs/version-4.x/apis/media/audio/pauseVoice.md deleted file mode 100644 index a55c4bc767c0..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/pauseVoice.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.pauseVoice(option) -sidebar_label: pauseVoice ---- - -暂停正在播放的语音。再次调用 [Taro.playVoice](/docs/apis/media/audio/stopVoice)。 -**注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](./createInnerAudioContext) 接口** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.pauseVoice.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startRecord({ - success: function (res) { - var tempFilePath = res.tempFilePath - Taro.playVoice({ - filePath: tempFilePath - }) - setTimeout(function() { - //暂停播放 - Taro.pauseVoice() - }, 5000) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/playVoice.md b/versioned_docs/version-4.x/apis/media/audio/playVoice.md deleted file mode 100644 index 6a7a0a36e6d6..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/playVoice.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.playVoice(option) -sidebar_label: playVoice ---- - -开始播放语音。同时只允许一个语音文件正在播放，如果前一个语音文件还没播放完，将中断前一个语音播放。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.playVoice.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 需要播放的语音文件的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| duration | `number` | 否 | 指定录音时长，到达指定的录音时长后会自动停止录音，单位：秒 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startRecord({ - success: function (res) { - const tempFilePath = res.tempFilePath - Taro.playVoice({ - filePath: tempFilePath, - complete: function () { } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/audio/setInnerAudioOption.md b/versioned_docs/version-4.x/apis/media/audio/setInnerAudioOption.md deleted file mode 100644 index 235c19ae7d7d..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/setInnerAudioOption.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.setInnerAudioOption(option) -sidebar_label: setInnerAudioOption ---- - -设置 [InnerAudioContext](/docs/apis/media/audio/InnerAudioContext)项。设置之后对当前小程序全局生效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.setInnerAudioOption.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| mixWithOther | `boolean` | 否 | 是否与其他音频混播，设置为 true 之后，不会终止其他应用或微信内的音乐 | -| obeyMuteSwitch | `boolean` | 否 | （仅在 iOS 生效）是否遵循静音开关，设置为 false 之后，即使是在静音模式下，也能播放声音 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/audio/stopVoice.md b/versioned_docs/version-4.x/apis/media/audio/stopVoice.md deleted file mode 100644 index aae614eef425..000000000000 --- a/versioned_docs/version-4.x/apis/media/audio/stopVoice.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.stopVoice(option) -sidebar_label: stopVoice ---- - -结束播放语音。 -**注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](./createInnerAudioContext) 接口** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.stopVoice.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.startRecord({ - success: function (res) { - const filePath = res.tempFilePath - Taro.playVoice({ filePath }) - - setTimeout(Taro.stopVoice, 5000) - } -}) -``` - -### 示例 2 - -```tsx -Taro.startRecord(params).then(res => { - const filePath = res.tempFilePath - Taro.playVoice({ filePath }) - - setTimeout(Taro.stopVoice, 5000) -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/BackgroundAudioManager.md b/versioned_docs/version-4.x/apis/media/background-audio/BackgroundAudioManager.md deleted file mode 100644 index 959a465a7ffc..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/BackgroundAudioManager.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: BackgroundAudioManager -sidebar_label: BackgroundAudioManager ---- - -BackgroundAudioManager 实例，可通过 [Taro.getBackgroundAudioManager](/docs/apis/media/background-audio/getBackgroundAudioManager) 获取。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/BackgroundAudioManager.html) - -## 方法 - -| 参数 | 类型 | 默认值 | 只读 | 必填 | 说明 | -| --- | --- | :---: | :---: | :---: | --- | -| src | `string` | | 否 | 是 | 音频的数据源（[2.2.3](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 开始支持云文件ID）。默认为空字符串，**当设置了新的 src 时，会自动开始播放**，目前支持的格式有 m4a, aac, mp3, wav。 | -| startTime | `number` | | 否 | 是 | 音频开始播放的位置（单位：s）。 | -| title | `string` | | 否 | 是 | 音频标题，用于原生音频播放器音频标题（必填）。原生音频播放器中的分享功能，分享出去的卡片标题，也将使用该值。 | -| epname | `string` | | 否 | 是 | 专辑名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值。 | -| singer | `string` | | 否 | 是 | 歌手名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值。 | -| coverImgUrl | `string` | | 否 | 是 | 封面图 URL，用于做原生音频播放器背景图。原生音频播放器中的分享功能，分享出去的卡片配图及背景也将使用该图。 | -| webUrl | `string` | | 否 | 是 | 页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值。 | -| protocol | `string` | | 否 | 是 | 音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频。 | -| playbackRate | `number` | `1` | 否 | 否 | 播放速度。范围 0.5-2.0。 | -| duration | `number` | | 是 | 是 | 当前音频的长度（单位：s），只有在有合法 src 时返回。 | -| currentTime | `number` | | 是 | 是 | 当前音频的播放位置（单位：s），只有在有合法 src 时返回。 | -| paused | `boolean` | | 是 | 是 | 当前是否暂停或停止。 | -| buffered | `number` | | 是 | 是 | 音频已缓冲的时间，仅保证当前播放时间点到此时间点内容已缓冲。 | -| referrerPolicy | `string` | | 否 | 否 | origin: 发送完整的 referrer; no-referrer: 不发送 | - -### play - -播放 - -```tsx -() => void -``` - -### pause - -暂停 - -```tsx -() => void -``` - -### seek - -跳转到指定位置，单位 s - -```tsx -(position: any) => void -``` - -### stop - -停止 - -```tsx -() => void -``` - -### onCanplay - -背景音频进入可以播放状态，但不保证后面可以流畅播放 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onWaiting - -音频加载中事件，当音频因为数据不足，需要停下来加载时会触发 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onError - -背景音频播放错误事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onPlay - -背景音频播放事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onPause - -背景音频暂停事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onSeeking - -背景音频开始跳转操作事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onSeeked - -背景音频完成跳转操作事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onEnded - -背景音频自然播放结束事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onStop - -背景音频停止事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onTimeUpdate - -背景音频播放进度更新事件 - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onPrev - -用户在系统音乐播放面板点击上一曲事件（iOS only） - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -### onNext - -用户在系统音乐播放面板点击下一曲事件（iOS only） - -```tsx -(callback?: () => void) => void -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | - -## 示例代码 - -```tsx -const backgroundAudioManager = Taro.getBackgroundAudioManager() -backgroundAudioManager.title = '此时此刻' -backgroundAudioManager.epname = '此时此刻' -backgroundAudioManager.singer = '许巍' -backgroundAudioManager.coverImgUrl = 'https://y.gtimg.cn/music/photo_new/T002R300x300M000003rsKF44GyaSk.jpg?max_age=2592000' -// 设置了 src 之后会自动播放 -backgroundAudioManager.src = 'https://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46' -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioManager.md b/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioManager.md deleted file mode 100644 index ca9aec9d8c37..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioManager.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.getBackgroundAudioManager() -sidebar_label: getBackgroundAudioManager ---- - -获取**全局唯一**的背景音频管理器。 -小程序切入后台，如果音频处于播放状态，可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。 - -从微信客户端6.7.2版本开始，若需要在小程序切后台后继续播放音频，需要在 [app.json](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html) 中配置 `requiredBackgroundModes` 属性。开发版和体验版上可以直接生效，正式版还需通过审核。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.getBackgroundAudioManager.html) - -## 类型 - -```tsx -() => BackgroundAudioManager -``` - -## 示例代码 - -```tsx -const backgroundAudioManager = Taro.getBackgroundAudioManager() -backgroundAudioManager.title = '此时此刻' -backgroundAudioManager.epname = '此时此刻' -backgroundAudioManager.singer = '许巍' -backgroundAudioManager.coverImgUrl = 'https://y.gtimg.cn/music/photo_new/T002R300x300M000003rsKF44GyaSk.jpg?max_age=2592000' -backgroundAudioManager.src = 'https://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46' // 设置了 src 之后会自动播放 -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioPlayerState.md b/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioPlayerState.md deleted file mode 100644 index 6d5ae71cfbeb..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/getBackgroundAudioPlayerState.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Taro.getBackgroundAudioPlayerState(option) -sidebar_label: getBackgroundAudioPlayerState ---- - -获取后台音乐播放状态。 -**注意：1.2.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.getBackgroundAudioManager](/docs/apis/media/background-audio/getBackgroundAudioManager) 接口** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.getBackgroundAudioPlayerState.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| currentPosition | `number` | 选定音频的播放位置（单位：s），只有在音乐播放中时返回 | -| dataUrl | `string` | 歌曲数据链接，只有在音乐播放中时返回 | -| downloadPercent | `number` | 音频的下载进度百分比，只有在音乐播放中时返回 | -| duration | `number` | 选定音频的长度（单位：s），只有在音乐播放中时返回 | -| status | `keyof Status` | 播放状态 | -| errMsg | `string` | 调用结果 | - -### Status - -| 参数 | 说明 | -| --- | --- | -| 0 | 暂停中 | -| 1 | 播放中 | -| 2 | 没有音乐播放 | - -## 示例代码 - -```tsx -Taro.getBackgroundAudioPlayerState({ - success: function (res) { - var status = res.status - var dataUrl = res.dataUrl - var currentPosition = res.currentPosition - var duration = res.duration - var downloadPercent = res.downloadPercent - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPause.md b/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPause.md deleted file mode 100644 index 4ebafa1670af..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPause.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.onBackgroundAudioPause(callback) -sidebar_label: onBackgroundAudioPause ---- - -监听音乐暂停。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioPause.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音乐暂停事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPlay.md b/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPlay.md deleted file mode 100644 index 5dd87d1dde49..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioPlay.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.onBackgroundAudioPlay(callback) -sidebar_label: onBackgroundAudioPlay ---- - -监听音乐播放。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioPlay.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音乐播放事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioStop.md b/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioStop.md deleted file mode 100644 index b1640f430789..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/onBackgroundAudioStop.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Taro.onBackgroundAudioStop(callback) -sidebar_label: onBackgroundAudioStop ---- - -监听音乐停止。 - -**bug & tip：** - -1. `bug`: `iOS` `6.3.30` Taro.seekBackgroundAudio 会有短暂延迟 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioStop.html) - -## 类型 - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 音乐停止事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/background-audio/pauseBackgroundAudio.md b/versioned_docs/version-4.x/apis/media/background-audio/pauseBackgroundAudio.md deleted file mode 100644 index 8a2551584d5e..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/pauseBackgroundAudio.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.pauseBackgroundAudio(option) -sidebar_label: pauseBackgroundAudio ---- - -暂停播放音乐。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.pauseBackgroundAudio.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.pauseBackgroundAudio() -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/playBackgroundAudio.md b/versioned_docs/version-4.x/apis/media/background-audio/playBackgroundAudio.md deleted file mode 100644 index 917baf42f9c7..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/playBackgroundAudio.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Taro.playBackgroundAudio(option) -sidebar_label: playBackgroundAudio ---- - -使用后台播放器播放音乐，对于微信客户端来说，只能同时有一个后台音乐在播放。当用户离开小程序后，音乐将暂停播放；当用户点击“显示在聊天顶部”时，音乐不会暂停播放；当用户在其他小程序占用了音乐播放器，原有小程序内的音乐将停止播放。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.playBackgroundAudio.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| dataUrl | `string` | 是 | 音乐链接，目前支持的格式有 m4a, aac, mp3, wav | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| coverImgUrl | `string` | 否 | 封面URL | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| title | `string` | 否 | 音乐标题 | - -## 示例代码 - -```tsx -Taro.playBackgroundAudio({ - dataUrl: '', - title: '', - coverImgUrl: '' -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/seekBackgroundAudio.md b/versioned_docs/version-4.x/apis/media/background-audio/seekBackgroundAudio.md deleted file mode 100644 index 17c79b82e9fb..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/seekBackgroundAudio.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.seekBackgroundAudio(option) -sidebar_label: seekBackgroundAudio ---- - -控制音乐播放进度。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.seekBackgroundAudio.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| position | `number` | 是 | 音乐位置，单位：秒 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.seekBackgroundAudio({ - position: 30 -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/background-audio/stopBackgroundAudio.md b/versioned_docs/version-4.x/apis/media/background-audio/stopBackgroundAudio.md deleted file mode 100644 index 53c3416ef8f8..000000000000 --- a/versioned_docs/version-4.x/apis/media/background-audio/stopBackgroundAudio.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.stopBackgroundAudio(option) -sidebar_label: stopBackgroundAudio ---- - -停止播放音乐。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.stopBackgroundAudio.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.stopBackgroundAudio() -``` diff --git a/versioned_docs/version-4.x/apis/media/camera/CameraContext.md b/versioned_docs/version-4.x/apis/media/camera/CameraContext.md deleted file mode 100644 index 244b56c35757..000000000000 --- a/versioned_docs/version-4.x/apis/media/camera/CameraContext.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -title: CameraContext -sidebar_label: CameraContext ---- - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.html) - -## 方法 - -### onCameraFrame - -获取 Camera 实时帧数据 - -**** - -注： 使用该接口需同时在 [camera](/docs/components/media/camera) 组件属性中指定 frame-size。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.onCameraFrame.html) - -```tsx -(callback: OnCameraFrameCallback) => CameraFrameListener -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnCameraFrameCallback` | 回调函数 | - -#### 示例代码 - -```tsx -const context = wx.createCameraContext() -const listener = context.onCameraFrame((frame) => { - console.log(frame.data instanceof ArrayBuffer, frame.width, frame.height) -}) -listener.start() -``` - -### setZoom - -设置缩放级别 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.setZoom.html) - -```tsx -(option: SetZoomOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetZoomOption` | - -### startRecord - -开始录像 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.startRecord.html) - -```tsx -(option: StartRecordOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartRecordOption` | - -### stopRecord - -结束录像 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.stopRecord.html) - -```tsx -(option?: StopRecordOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopRecordOption` | - -### takePhoto - -拍摄照片 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.takePhoto.html) - -```tsx -(option: TakePhotoOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `TakePhotoOption` | - -## 参数 - -### SetZoomOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: StartRecordSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| zoom | `number` | 是 | 缩放级别，范围[1, maxZoom]。zoom 可取小数，精确到小数后一位。maxZoom 可在 bindinitdone 返回值中获取。 | - -### StartRecordSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| zoom | `number` | 实际设置的缩放级别。由于系统限制，某些机型可能无法设置成指定值，会改用最接近的可设值。 | -| setZoom | `number` |
API 支持度: alipay
alipay: on android | - -### StartRecordOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| timeoutCallback | `StartRecordTimeoutCallback` | 否 | 超过30s或页面 `onHide` 时会结束录像 | - -### StartRecordTimeoutCallback - -超过30s或页面 `onHide` 时会结束录像 - -```tsx -(result: StartRecordTimeoutCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `StartRecordTimeoutCallbackResult` | - -### StartRecordTimeoutCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempThumbPath | `string` | 封面图片文件的临时路径 | -| tempVideoPath | `string` | 视频的文件的临时路径 | -| height | `string` | 视频文件的高度。
API 支持度: alipay | -| width | `string` | 视频文件的宽度。
API 支持度: alipay | -| size | `string` | 视频文件的尺寸。
API 支持度: alipay | -| duration | `string` | 录制的持续时间。
API 支持度: alipay | - -### StopRecordOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: StopRecordSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopRecordSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempThumbPath | `string` | 封面图片文件的临时路径 | -| tempVideoPath | `string` | 视频的文件的临时路径 | -| errMsg | `string` | 调用结果 | - -### TakePhotoOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| quality | `keyof Quality` | 否 | 成像质量 | -| success | `(result: TakePhotoSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### TakePhotoSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempImagePath | `string` | 照片文件的临时路径，安卓是jpg图片格式，ios是png | -| errMsg | `string` | 调用结果 | - -### OnCameraFrameCallback - -回调函数 - -```tsx -(result: OnCameraFrameCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnCameraFrameCallbackResult` | - -### OnCameraFrameCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `ArrayBuffer` | 图像像素点数据，一维数组，每四项表示一个像素点的 rgba | -| height | `number` | 图像数据矩形的高度 | -| width | `number` | 图像数据矩形的宽度 | - -### Quality - -| 参数 | 说明 | -| --- | --- | -| high | 高质量 | -| normal | 普通质量 | -| low | 低质量 | -| original | 原图 | - -## API 支持度 - -| API | 微信小程序 | 支付宝小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| CameraContext.onCameraFrame | ✔️ | ✔️ | ✔️ | | | | -| CameraContext.setZoom | ✔️ | ✔️ | ✔️ | | | | -| CameraContext.startRecord | ✔️ | ✔️ | ✔️ | | ✔️ | | -| CameraContext.stopRecord | ✔️ | ✔️ | ✔️ | | ✔️ | | -| CameraContext.takePhoto | ✔️ | ✔️ | ✔️ | | ✔️ | | diff --git a/versioned_docs/version-4.x/apis/media/camera/CameraFrameListener.md b/versioned_docs/version-4.x/apis/media/camera/CameraFrameListener.md deleted file mode 100644 index 799b79ad5258..000000000000 --- a/versioned_docs/version-4.x/apis/media/camera/CameraFrameListener.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: CameraFrameListener -sidebar_label: CameraFrameListener ---- - -CameraContext.onCameraFrame() 返回的监听器。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraFrameListener.html) - -## 方法 - -### start - -开始监听帧数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraFrameListener.start.html) - -```tsx -(option?: StartOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartOption` | - -### stop - -停止监听帧数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraFrameListener.stop.html) - -```tsx -(option?: StopOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopOption` | - -## 参数 - -### StartOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| CameraFrameListener.start | ✔️ | ✔️ | | | | -| CameraFrameListener.stop | ✔️ | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/camera/createCameraContext.md b/versioned_docs/version-4.x/apis/media/camera/createCameraContext.md deleted file mode 100644 index 9ce3b4b81943..000000000000 --- a/versioned_docs/version-4.x/apis/media/camera/createCameraContext.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.createCameraContext(id) -sidebar_label: createCameraContext ---- - -创建 camera 上下文 CameraContext 对象。 - -支持情况： - -> 支付宝小程序: 支付宝小程序需指定 camera 组件中的 id 属性 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/wx.createCameraContext.html) - -## 类型 - -```tsx -(id?: string) => CameraContext -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| id | `string` | - -## 示例代码 - -```tsx -const cameraContext = Taro.createCameraContext() -``` diff --git a/versioned_docs/version-4.x/apis/media/editor/EditorContext.md b/versioned_docs/version-4.x/apis/media/editor/EditorContext.md deleted file mode 100644 index 6f3d81a0dc39..000000000000 --- a/versioned_docs/version-4.x/apis/media/editor/EditorContext.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -title: EditorContext -sidebar_label: EditorContext ---- - -`EditorContext` 实例，可通过 `Taro.createSelectorQuery` 获取。 -`EditorContext` 通过 `id` 跟一个 `editor` 组件绑定，操作对应的 `editor` 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.html) - -## 方法 - -### blur - -编辑器失焦，同时收起键盘。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.blur.html) - -```tsx -(option?: BlurOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `BlurOption` | - -### clear - -清空编辑器内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.clear.html) - -```tsx -(option?: ClearOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ClearOption` | - -### format - -修改样式 - -**** - -## 支持设置的样式列表 -| name | value | -| ------| ------ | -| bold | | -| italic | | -| underline | | -| strike | | -| ins | | -| script | sub / super | -| header | H1 / H2 / h3 / H4 / h5 / H6 | -| align | left / center / right / justify | -| direction | rtl | -| indent | -1 / +1 | -| list | ordered / bullet / check | -| color | hex color | -| backgroundColor| hex color | -| margin/marginTop/marginBottom/marginLeft/marginRight | css style | -| padding/paddingTop/paddingBottom/paddingLeft/paddingRight | css style | -| font/fontSize/fontStyle/fontVariant/fontWeight/fontFamily | css style | -| lineHeight | css style | -| letterSpacing | css style | -| textDecoration | css style | -| textIndent | css style | - -对已经应用样式的选区设置会取消样式。css style 表示 css 中规定的允许值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.format.html) - -```tsx -(name: string, value?: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| name | `string` | 属性 | -| value | `string` | 值 | - -### getContents - -获取编辑器内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.getContents.html) - -```tsx -(option?: GetContentsOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetContentsOption` | - -### getSelectionText - -获取编辑器已选区域内的纯文本内容。当编辑器失焦或未选中一段区间时，返回内容为空。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.getSelectionText.html) - -```tsx -(option?: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### insertDivider - -插入分割线 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.insertDivider.html) - -```tsx -(option?: InsertDividerOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `InsertDividerOption` | - -### insertImage - -插入图片。 - -地址为临时文件时，获取的编辑器html格式内容中 `` 标签增加属性 data-local，delta 格式内容中图片 attributes 属性增加 data-local 字段，该值为传入的临时文件地址。 - -开发者可选择在提交阶段上传图片到服务器，获取到网络地址后进行替换。替换时对于html内容应替换掉 `` 的 src 值，对于 delta 内容应替换掉 `insert { image: abc }` 值。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.insertImage.html) - -```tsx -(option: InsertImageOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `InsertImageOption` | - -#### 示例代码 - -```tsx -this.editorCtx.insertImage({ - src: 'xx', - width: '100px', - height: '50px', - extClass: className -}) -``` - -### insertText - -覆盖当前选区，设置一段文本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.insertText.html) - -```tsx -(option: InsertTextOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `InsertTextOption` | - -### redo - -恢复 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.redo.html) - -```tsx -(option?: RedoOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RedoOption` | - -### removeFormat - -清除当前选区的样式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.removeFormat.html) - -```tsx -(option?: RemoveFormatOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveFormatOption` | - -### scrollIntoView - -使得编辑器光标处滚动到窗口可视区域内。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.scrollIntoView.html) - -```tsx -() => void -``` - -### setContents - -初始化编辑器内容，html和delta同时存在时仅delta生效 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.setContents.html) - -```tsx -(option: SetContentsOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetContentsOption` | - -### undo - -撤销 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/editor/EditorContext.undo.html) - -```tsx -(option?: UndoOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `UndoOption` | - -## 参数 - -### BlurOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ClearOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetContentsOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### getSelectionText - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| text | `string` | 纯文本内容 | - -### InsertDividerOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### InsertImageOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 图片地址，仅支持 http(s)、base64、云图片(2.8.0)、临时文件(2.8.3)。 | -| nowrap | `boolean` | 否 | 插入图片后是否自动换行，默认换行 | -| alt | `string` | 否 | 图像无法显示时的替代文本 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| data | `TaroGeneral.IAnyObject` | 否 | data 被序列化为 name=value;name1=value2 的格式挂在属性 data-custom 上 | -| extClass | `string` | 否 | 添加到图片 img 标签上的类名 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| height | `string` | 否 | 图片高度 (pixels/百分比) | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| width | `string` | 否 | 图片宽度（pixels/百分比) | - -### InsertTextOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| text | `string` | 否 | 文本内容 | - -### RedoOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RemoveFormatOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SetContentsOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| delta | `TaroGeneral.IAnyObject` | 否 | 表示内容的delta对象 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| html | `string` | 否 | 带标签的HTML内容 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### UndoOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| EditorContext | ✔️ | | | | -| EditorContext.blur | ✔️ | | | | -| EditorContext.clear | ✔️ | | | | -| EditorContext.format | ✔️ | | | | -| EditorContext.getContents | ✔️ | | | | -| EditorContext.getSelectionText | ✔️ | | | | -| EditorContext.insertDivider | ✔️ | | | | -| EditorContext.insertImage | ✔️ | | | | -| EditorContext.insertText | ✔️ | | | | -| EditorContext.redo | ✔️ | | | | -| EditorContext.removeFormat | ✔️ | | | | -| EditorContext.scrollIntoView | ✔️ | | | | -| EditorContext.setContents | ✔️ | | | | -| EditorContext.undo | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/image/chooseImage.md b/versioned_docs/version-4.x/apis/media/image/chooseImage.md deleted file mode 100644 index 534025f66730..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/chooseImage.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Taro.chooseImage(option) -sidebar_label: chooseImage ---- - -从本地相册选择图片或使用相机拍照。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.chooseImage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| count | `number` | `9` | 否 | 最多可以选择的图片张数
API 支持度: weapp, alipay, swan, tt, h5, rn | -| sizeType | `(keyof sizeType)[]` | `['original', 'compressed']` | 否 | 所选的图片的尺寸
API 支持度: weapp, alipay, swan, tt, rn | -| sourceType | `(keyof sourceType)[]` | `['album', 'camera']` | 否 | 选择图片的来源
API 支持度: weapp, alipay, swan, tt, h5, rn | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| imageId | `string` | | 否 | 用来上传的input元素ID（仅h5端
API 支持度: h5 | - -### sizeType - -图片的尺寸 - -| 参数 | 说明 | -| --- | --- | -| original | 原图 | -| compressed | compressed | - -### sourceType - -图片的来源 - -| 参数 | 说明 | -| --- | --- | -| album | 从相册选图 | -| camera | 使用相机 | -| user | 使用前置摄像头(仅H5纯浏览器使用) | -| environment | 使用后置摄像头(仅H5纯浏览器) | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePaths | `string[]` | 图片的本地临时文件路径列表 | -| tempFiles | `ImageFile[]` | 图片的本地临时文件列表 | -| errMsg | `string` | 调用结果 | - -### ImageFile - -图片的本地临时文件列表 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 本地临时文件路径 | -| size | `number` | 是 | 本地临时文件大小，单位 B | -| type | `string` | 否 | 文件的 MIME 类型
API 支持度: h5 | -| originalFileObj | `File` | 否 | 原始的浏览器 File 对象
API 支持度: h5 | - -## 示例代码 - -```tsx -Taro.chooseImage({ - count: 1, // 默认9 - sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图，默认二者都有 - sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机，默认二者都有，在H5浏览器端支持使用 `user` 和 `environment`分别指定为前后摄像头 - success: function (res) { - // 返回选定照片的本地文件路径列表，tempFilePath可以作为img标签的src属性显示图片 - var tempFilePaths = res.tempFilePaths - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/chooseMessageFile.md b/versioned_docs/version-4.x/apis/media/image/chooseMessageFile.md deleted file mode 100644 index 3014aeb6c6b0..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/chooseMessageFile.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Taro.chooseMessageFile(option) -sidebar_label: chooseMessageFile ---- - -从客户端会话选择文件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.chooseMessageFile.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| count | `number` | 是 | 最多可以选择的文件个数，可以 0～100 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| extension | `string[]` | 否 | 根据文件拓展名过滤，仅 type==file 时有效。每一项都不能是空字符串。默认不过滤。 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| type | `keyof SelectType` | 否 | 所选的文件的类型 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFiles | `ChooseFile[]` | 返回选择的文件的本地临时文件对象数组 | -| errMsg | `string` | 调用结果 | - -### ChooseFile - -返回选择的文件的本地临时文件对象数组 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| name | `string` | 选择的文件名称 | -| path | `string` | 本地临时文件路径 | -| size | `number` | 本地临时文件大小，单位 B | -| time | `number` | 选择的文件的会话发送时间，Unix时间戳，工具暂不支持此属性 | -| type | `keyof SelectedType` | 选择的文件类型 | - -### SelectType - -| 参数 | 说明 | -| --- | --- | -| all | 从所有文件选择 | -| video | 只能选择视频文件 | -| image | 只能选择图片文件 | -| file | 可以选择除了图片和视频之外的其它的文件 | - -### SelectedType - -| 参数 | 说明 | -| --- | --- | -| video | 选择了视频文件 | -| image | 选择了图片文件 | -| file | 选择了除图片和视频的文件 | - -## 示例代码 - -```tsx -Taro.chooseMessageFile({ - count: 10, - type: 'image', - success: function (res) { - // tempFilePath可以作为img标签的src属性显示图片 - const tempFilePaths = res.tempFiles - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/compressImage.md b/versioned_docs/version-4.x/apis/media/image/compressImage.md deleted file mode 100644 index 33be3beb59f0..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/compressImage.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.compressImage(option) -sidebar_label: compressImage ---- - -压缩图片接口，可选压缩质量 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.compressImage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 图片路径，图片的路径，可以是相对路径、临时文件路径、存储文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| quality | `number` | 否 | 压缩质量，范围0～100，数值越小，质量越低，压缩率越高（仅对jpg有效）。 | -| compressedWidth | `number` | 否 | 压缩后图片的宽度，单位为px，若不填写则默认以 compressedHeight 为准等比缩放。 | -| compressHeight | `number` | 否 | 压缩后图片的高度，单位为px，若不填写则默认以 compressedWidth 为准等比缩放。 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 压缩后图片的临时文件路径 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.compressImage({ - src: '', // 图片路径 - quality: 80 // 压缩质量 -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/cropImage.md b/versioned_docs/version-4.x/apis/media/image/cropImage.md deleted file mode 100644 index 7638125eda73..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/cropImage.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Taro.cropImage(option) -sidebar_label: cropImage ---- - -裁剪图片接口 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.cropImage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 图片路径，图片的路径，支持本地路径、代码包路径 | -| cropScale | `keyof CropScale` | 是 | 裁剪比例 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 剪裁后图片的临时文件路径 (本地路径) | - -### CropScale - -| 参数 | 说明 | -| --- | --- | -| 1:1 | 宽高比为1比1 | -| 3:4 | 宽高比为3比4 | -| 4:3 | 宽高比为4比3 | -| 4:5 | 宽高比为4比5 | -| 5:4 | 宽高比为5比4 | -| 6:19 | 宽高比为6比19 | -| 19:6 | 宽高比为19比6 | - -## 示例代码 - -```tsx -Taro.cropImage({ - src: '', // 图片路径 - cropScale: '1:1', // 裁剪比例 - success: function (res) { - // 返回选定照片的本地文件路径列表，tempFilePath可以作为img标签的src属性显示图片 - var tempFilePaths = res.tempFilePaths - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/editImage.md b/versioned_docs/version-4.x/apis/media/image/editImage.md deleted file mode 100644 index 26dae205e1cd..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/editImage.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.editImage(option) -sidebar_label: editImage ---- - -编辑图片接口 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.editImage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 图片路径，图片的路径，支持本地路径、代码包路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 编辑后图片的临时文件路径 (本地路径) | - -## 示例代码 - -```tsx -Taro.editImage({ - src: '', // 图片路径 -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/getImageInfo.md b/versioned_docs/version-4.x/apis/media/image/getImageInfo.md deleted file mode 100644 index ea369bdf6af0..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/getImageInfo.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.getImageInfo(option) -sidebar_label: getImageInfo ---- - -获取图片信息。网络图片需先配置download域名才能生效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.getImageInfo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 图片的路径，可以是相对路径、临时文件路径、存储文件路径、网络图片路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 默认值 | 说明 | -| --- | --- | :---: | --- | -| height | `number` | | 图片原始高度，单位px。不考虑旋转。 | -| orientation | `keyof Orientation` | `"up"` | [拍照时设备方向](http://sylvana.net/jpegcrop/exif_orientation.html) | -| path | `string` | | 图片的本地路径 | -| type | `string` | | 图片格式 | -| width | `number` | | 图片原始宽度，单位px。不考虑旋转。 | -| errMsg | `string` | | 调用结果 | - -### Orientation - -| 参数 | 说明 | -| --- | --- | -| up | 默认方向（手机横持拍照），对应 Exif 中的 1。或无 orientation 信息。 | -| up-mirrored | 同 up，但镜像翻转，对应 Exif 中的 2 | -| down | 旋转180度，对应 Exif 中的 3 | -| down-mirrored | 同 down，但镜像翻转，对应 Exif 中的 4 | -| left-mirrored | 同 left，但镜像翻转，对应 Exif 中的 5 | -| right | 顺时针旋转90度，对应 Exif 中的 6 | -| right-mirrored | 同 right，但镜像翻转，对应 Exif 中的 7 | -| left | 逆时针旋转90度，对应 Exif 中的 8 | - -## 示例代码 - -```tsx -Taro.getImageInfo({ - src: 'images/a.jpg', - success: function (res) { - console.log(res.width) - console.log(res.height) - } -}) -Taro.chooseImage({ - success: function (res) { - Taro.getImageInfo({ - src: res.tempFilePaths[0], - success: function (res) { - console.log(res.width) - console.log(res.height) - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/previewImage.md b/versioned_docs/version-4.x/apis/media/image/previewImage.md deleted file mode 100644 index 7f58679fdaf2..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/previewImage.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.previewImage(option) -sidebar_label: previewImage ---- - -在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.previewImage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| urls | `string[]` | 是 | 需要预览的图片链接列表。 | -| current | string or number | 否 | 微信端为当前显示图片的链接，支付宝端为当前显示图片的索引值 | -| enablesavephoto | `boolean` | 否 | 是否支持长按下载图片
API 支持度: alipay 基础库: 1.13.0 | -| enableShowPhotoDownload | `boolean` | 否 | 是否在右下角显示下载入口
API 支持度: alipay 基础库: 1.13.0 | -| showmenu | `boolean` | 否 |
API 支持度: weapp 最低版本：2.13.0。是否显示长按菜单，默认值：true | -| referrerPolicy | `string` | 否 |
API 支持度: weapp 最低版本：2.13.0。origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；默认值：no-referrer | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.previewImage({ - current: '', // 当前显示图片的http链接 - urls: [] // 需要预览的图片http链接列表 -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/previewMedia.md b/versioned_docs/version-4.x/apis/media/image/previewMedia.md deleted file mode 100644 index bdeb2655fb75..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/previewMedia.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.previewMedia(option) -sidebar_label: previewMedia ---- - -预览图片和视频。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.previewMedia.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Sources - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 图片或视频的地址 | -| type | "image" or "video" | 否 | 资源的类型（图片或视频），默认值：image | -| poster | `string` | 否 | 视频的封面图片 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| sources | `Sources[]` | 是 | 需要预览的资源列表 | -| current | `number` | 否 | 当前显示的资源序号，默认值：0 | -| showmenu | `boolean` | 否 | 是否显示长按菜单 2.13.0，默认值：true | -| referrerPolicy | `string` | 否 | origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；默认值：no-referrer | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.previewMedia({ - sources: [] -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/image/saveImageToPhotosAlbum.md b/versioned_docs/version-4.x/apis/media/image/saveImageToPhotosAlbum.md deleted file mode 100644 index 469425053f91..000000000000 --- a/versioned_docs/version-4.x/apis/media/image/saveImageToPhotosAlbum.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.saveImageToPhotosAlbum(option) -sidebar_label: saveImageToPhotosAlbum ---- - -保存图片到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.saveImageToPhotosAlbum.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 图片文件路径，可以是临时文件路径或永久文件路径，不支持网络图片路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.saveImageToPhotosAlbum({ - success: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/live/LivePlayerContext.md b/versioned_docs/version-4.x/apis/media/live/LivePlayerContext.md deleted file mode 100644 index 19880c0b0189..000000000000 --- a/versioned_docs/version-4.x/apis/media/live/LivePlayerContext.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -title: LivePlayerContext -sidebar_label: LivePlayerContext ---- - -`LivePlayerContext` 实例，可通过 `Taro.createLivePlayerContext` 获取。 -`LivePlayerContext` 通过 `id` 跟一个 `live-player` 组件绑定，操作对应的 `live-player` 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.html) - -## 方法 - -### exitCasting - -退出投屏。仅支持在 tap 事件回调内调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.exitCasting.html) - -```tsx -(option?: ExitCastingOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ExitCastingOption` | - -### exitFullScreen - -退出全屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.exitFullScreen.html) - -```tsx -(option?: ExitFullScreenOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ExitFullScreenOption` | - -### exitPictureInPicture - -退出小窗，该方法可在任意页面调用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.exitPictureInPicture.html) - -```tsx -(option?: ExitPictureInPictureOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ExitPictureInPictureOption` | - -### mute - -静音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.mute.html) - -```tsx -(option?: MuteOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `MuteOption` | - -### pause - -暂停 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.pause.html) - -```tsx -(option?: PauseOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `PauseOption` | - -### play - -播放 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.play.html) - -```tsx -(option?: PlayOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `PlayOption` | - -### reconnectCasting - -重连投屏设备。仅支持在 tap 事件回调内调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.reconnectCasting.html) - -```tsx -(option?: ReconnectCastingOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ReconnectCastingOption` | - -### requestFullScreen - -进入全屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.requestFullScreen.html) - -```tsx -(option: RequestFullScreenOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RequestFullScreenOption` | - -### requestPictureInPicture - -进入全屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.requestPictureInPicture.html) - -```tsx -(option: RequestPictureInPictureOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RequestPictureInPictureOption` | - -### resume - -恢复 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.resume.html) - -```tsx -(option?: ResumeOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ResumeOption` | - -### snapshot - -截图 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.snapshot.html) - -```tsx -(option?: SnapshotOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SnapshotOption` | - -### startCasting - -开始投屏, 拉起半屏搜索设备。仅支持在 tap 事件回调内调用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.startCasting.html) - -```tsx -(option?: StartCastingOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartCastingOption` | - -### stop - -停止 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.stop.html) - -```tsx -(option?: StopOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopOption` | - -### switchCasting - -切换投屏设备。仅支持在 tap 事件回调内调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.switchCasting.html) - -```tsx -(option?: SwitchCastingOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SwitchCastingOption` | - -## 参数 - -### ExitCastingOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ExitFullScreenOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ExitPictureInPictureOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### MuteOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### PauseOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### PlayOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ReconnectCastingOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RequestFullScreenOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| direction | 0 or 90 or -90 | 否 | 设置全屏时的方向

可选值：
- 0: 正常竖向;
- 90: 屏幕逆时针90度;
- -90: 屏幕顺时针90度; | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RequestPictureInPictureOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ResumeOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SnapshotOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SnapshotSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SnapshotSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| height | `string` | 图片的高度 | -| tempImagePath | `string` | 图片文件的临时路径 | -| width | `string` | 图片的宽度 | -| errMsg | `string` | 调用结果 | - -### StartCastingOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SwitchCastingOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| LivePlayerContext | ✔️ | | | | -| LivePlayerContext.exitCasting | ✔️ | | | | -| LivePlayerContext.exitFullScreen | ✔️ | | | | -| LivePlayerContext.exitPictureInPicture | ✔️ | | | | -| LivePlayerContext.mute | ✔️ | | | | -| LivePlayerContext.pause | ✔️ | | | | -| LivePlayerContext.play | ✔️ | | | | -| LivePlayerContext.reconnectCasting | ✔️ | | | | -| LivePlayerContext.requestFullScreen | ✔️ | | | | -| LivePlayerContext.requestPictureInPicture | ✔️ | | | | -| LivePlayerContext.resume | ✔️ | | | | -| LivePlayerContext.snapshot | ✔️ | | | | -| LivePlayerContext.startCasting | ✔️ | | | | -| LivePlayerContext.stop | ✔️ | | | | -| LivePlayerContext.switchCasting | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/live/LivePusherContext.md b/versioned_docs/version-4.x/apis/media/live/LivePusherContext.md deleted file mode 100644 index 2f088343174d..000000000000 --- a/versioned_docs/version-4.x/apis/media/live/LivePusherContext.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -title: LivePusherContext -sidebar_label: LivePusherContext ---- - -`LivePusherContext` 实例，可通过 `Taro.createLivePusherContext` 获取。 -`LivePusherContext` 与页面内唯一的 `live-pusher` 组件绑定，操作对应的 `live-pusher` 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.html) - -## 方法 - -### pause - -暂停推流 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.pause.html) - -```tsx -(option?: PauseOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `PauseOption` | - -### pauseBGM - -暂停背景音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.pauseBGM.html) - -```tsx -(option?: PauseBGMOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `PauseBGMOption` | - -### playBGM - -播放背景音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.playBGM.html) - -```tsx -(option: PlayBGMOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `PlayBGMOption` | - -### resume - -恢复推流 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.resume.html) - -```tsx -(option?: ResumeOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ResumeOption` | - -### resumeBGM - -恢复背景音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.resumeBGM.html) - -```tsx -(option?: ResumeBGMOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ResumeBGMOption` | - -### sendMessage - -发送SEI消息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.sendMessage.html) - -```tsx -(option?: SendMessageOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SendMessageOption` | - -### setBGMVolume - -设置背景音音量 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.setBGMVolume.html) - -```tsx -(option: SetBGMVolumeOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetBGMVolumeOption` | - -### setMICVolume - -设置麦克风音量 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.setMICVolume.html) - -```tsx -(option: SetMICVolumeOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetMICVolumeOption` | - -### snapshot - -快照 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.snapshot.html) - -```tsx -(option?: SnapshotOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SnapshotOption` | - -### start - -开始推流，同时开启摄像头预览 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.start.html) - -```tsx -(option?: StartOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartOption` | - -### startPreview - -开启摄像头预览 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.startPreview.html) - -```tsx -(option?: StartPreviewOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartPreviewOption` | - -### stop - -停止推流，同时停止摄像头预览 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.stop.html) - -```tsx -(option?: StopOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopOption` | - -### stopBGM - -停止背景音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.stopBGM.html) - -```tsx -(option?: StopBGMOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopBGMOption` | - -### stopPreview - -关闭摄像头预览 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.stopPreview.html) - -```tsx -(option?: StopPreviewOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StopPreviewOption` | - -### switchCamera - -切换前后摄像头 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.switchCamera.html) - -```tsx -(option?: SwitchCameraOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SwitchCameraOption` | - -### toggleTorch - -切换手电筒 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePusherContext.toggleTorch.html) - -```tsx -(option?: ToggleTorchOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ToggleTorchOption` | - -## 参数 - -### PauseOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### PauseBGMOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### PlayBGMOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 加入背景混音的资源地址 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ResumeOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ResumeBGMOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SendMessageOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| msg | `string` | 是 | SEI消息 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SetBGMVolumeOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| volume | `number` | 是 | 音量大小，范围是 0-1 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SetMICVolumeOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| volume | `number` | 是 | 音量大小，范围是 0-1 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SnapshotOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StartOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StartPreviewOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopBGMOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### StopPreviewOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SwitchCameraOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ToggleTorchOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| LivePusherContext | ✔️ | | | | -| LivePusherContext.pause | ✔️ | | | | -| LivePusherContext.pauseBGM | ✔️ | | | | -| LivePusherContext.playBGM | ✔️ | | | | -| LivePusherContext.resume | ✔️ | | | | -| LivePusherContext.resumeBGM | ✔️ | | | | -| LivePusherContext.sendMessage | ✔️ | | | | -| LivePusherContext.setBGMVolume | ✔️ | | | | -| LivePusherContext.setMICVolume | ✔️ | | | | -| LivePusherContext.snapshot | ✔️ | | | | -| LivePusherContext.start | ✔️ | | | | -| LivePusherContext.startPreview | ✔️ | | | | -| LivePusherContext.stop | ✔️ | | | | -| LivePusherContext.stopBGM | ✔️ | | | | -| LivePusherContext.stopPreview | ✔️ | | | | -| LivePusherContext.switchCamera | ✔️ | | | | -| LivePusherContext.toggleTorch | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/live/createLivePlayerContext.md b/versioned_docs/version-4.x/apis/media/live/createLivePlayerContext.md deleted file mode 100644 index 137fdf8590fb..000000000000 --- a/versioned_docs/version-4.x/apis/media/live/createLivePlayerContext.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Taro.createLivePlayerContext(id, component) -sidebar_label: createLivePlayerContext ---- - -创建 [live-player](/docs/components/media/live-player) 上下文 [LivePlayerContext](/docs/apis/media/live/LivePlayerContext) 对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/wx.createLivePlayerContext.html) - -## 类型 - -```tsx -(id: string, component?: TaroGeneral.IAnyObject) => LivePlayerContext -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `string` | [live-player](/docs/components/media/live-player) 组件的 id | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 [live-player](/docs/components/media/live-player) 组件 | diff --git a/versioned_docs/version-4.x/apis/media/live/createLivePusherContext.md b/versioned_docs/version-4.x/apis/media/live/createLivePusherContext.md deleted file mode 100644 index cc5660cd6232..000000000000 --- a/versioned_docs/version-4.x/apis/media/live/createLivePusherContext.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.createLivePusherContext() -sidebar_label: createLivePusherContext ---- - -创建 [live-pusher](/docs/components/media/live-pusher) 上下文 [LivePusherContext](/docs/apis/media/live/LivePusherContext) 对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/wx.createLivePusherContext.html) - -## 类型 - -```tsx -() => LivePusherContext -``` diff --git a/versioned_docs/version-4.x/apis/media/map/MapContext.md b/versioned_docs/version-4.x/apis/media/map/MapContext.md deleted file mode 100644 index 6f9b37381218..000000000000 --- a/versioned_docs/version-4.x/apis/media/map/MapContext.md +++ /dev/null @@ -1,849 +0,0 @@ ---- -title: MapContext -sidebar_label: MapContext ---- - -`MapContext` 实例，可通过 [Taro.createMapContext](./createMapContext) 获取。 -`MapContext` 通过 id 跟一个 map 组件绑定，操作对应的 map 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.html) - -## 方法 - -### getCenterLocation - -获取当前地图中心的经纬度。返回的是 gcj02 坐标系，可以用于 [Taro.openLocation()](/docs/apis/location/openLocation) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getCenterLocation.html) - -```tsx -(option?: GetCenterLocationOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetCenterLocationOption` | - -### setLocMarkerIcon - -设置定位点图标，支持网络路径、本地路径、代码包路径 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.setLocMarkerIcon.html) - -```tsx -(option?: SetLocMarkerIconOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetLocMarkerIconOption` | - -### moveToLocation - -将地图中心移置当前定位点，此时需设置地图组件 show-location 为true。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.moveToLocation.html) - -```tsx -(option: MoveToLocationOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `MoveToLocationOption` | - -### translateMarker - -平移marker，带动画 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.translateMarker.html) - -```tsx -(option: TranslateMarkerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `TranslateMarkerOption` | - -### moveAlong - -沿指定路径移动 marker，用于轨迹回放等场景。动画完成时触发回调事件，若动画进行中，对同一 marker 再次调用 moveAlong 方法，前一次的动画将被打断。 - -```tsx -(object: any) => any -``` - -### includePoints - -缩放视野展示所有经纬度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.includePoints.html) - -```tsx -(option: IncludePointsOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `IncludePointsOption` | - -### getRegion - -获取当前地图的视野范围 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getRegion.html) - -```tsx -(option?: GetRegionOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetRegionOption` | - -### getRotate - -获取当前地图的旋转角 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getRotate.html) - -```tsx -(option?: GetRotateOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetRotateOption` | - -### getSkew - -获取当前地图的倾斜角 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getSkew.html) - -```tsx -(option?: GetSkewOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetSkewOption` | - -### getScale - -获取当前地图的缩放级别 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getScale.html) - -```tsx -(option?: GetScaleOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `GetScaleOption` | - -### setCenterOffset - -设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5] - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.setCenterOffset.html) - -```tsx -(option: SetCenterOffsetOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetCenterOffsetOption` | - -### removeCustomLayer - -移除个性化图层。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeCustomLayer.html) - -```tsx -(option: RemoveCustomLayerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveCustomLayerOption` | - -### addCustomLayer - -添加个性化图层。图层创建参考文档 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addCustomLayer.html) - -```tsx -(option: AddCustomLayerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddCustomLayerOption` | - -### addGroundOverlay - -创建自定义图片图层，图片会随着地图缩放而缩放。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addGroundOverlay.html) - -```tsx -(option: AddGroundLayerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddGroundLayerOption` | - -### addVisualLayer - -添加可视化图层。需要刷新时，interval 可设置的最小值为 15 s。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addVisualLayer.html) - -```tsx -(option: AddVisualLayerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddVisualLayerOption` | - -### removeVisualLayer - -移除可视化图层。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeVisualLayer.html) - -```tsx -(option: RemoveVisualLayerOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveVisualLayerOption` | - -### addArc - -添加弧线，途经点与夹角必须设置一个。途经点必须在起终点有效坐标范围内，否则不能生成正确的弧线，同时设置夹角角度时，以夹角角度为准。夹角定义为起点到终点，与起点外切线逆时针旋转的角度。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addArc.html) - -```tsx -(option: AddArcOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddArcOption` | - -### removeArc - -删除弧线。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeArc.html) - -```tsx -(option: RemoveArcOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveArcOption` | - -### setBoundary - -限制地图的显示范围。此接口同时会限制地图的最小缩放整数级别。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.setBoundary.html) - -```tsx -(option: SetBoundaryOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SetBoundaryOption` | - -### updateGroundOverlay - -更新自定义图片图层。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.updateGroundOverlay.html) - -```tsx -(option: UpdateGroundOverlayOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `UpdateGroundOverlayOption` | - -### removeGroundOverlay - -移除自定义图片图层。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeGroundOverlay.html) - -```tsx -(option: RemoveGroundOverlayOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveGroundOverlayOption` | - -### toScreenLocation - -获取经纬度对应的屏幕坐标，坐标原点为地图左上角。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.toScreenLocation.html) - -```tsx -(option: ToScreenLocationOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ToScreenLocationOption` | - -### fromScreenLocation - -获取屏幕上的点对应的经纬度，坐标原点为地图左上角。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.fromScreenLocation.html) - -```tsx -(option: FromScreenLocationOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `FromScreenLocationOption` | - -### openMapApp - -拉起地图APP选择导航。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.openMapApp.html) - -```tsx -(option: OpenMapAppOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `OpenMapAppOption` | - -### addMarkers - -添加 marker。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addMarkers.html) - -```tsx -(option: AddMarkersOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddMarkersOption` | - -### removeMarkers - -移除 marker。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeMarkers.html) - -```tsx -(option: RemoveMarkersOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RemoveMarkersOption` | - -### initMarkerCluster - -初始化点聚合的配置，未调用时采用默认配置。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.initMarkerCluster.html) - -```tsx -(option?: InitMarkerClusterOption) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `InitMarkerClusterOption` | - -### on - -监听地图事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.on.html) - -```tsx -(event: keyof MapEvent, callback: (res: MapEventMarkerClusterCreate | MapEventMarkerClusterClick) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| event | `keyof MapEvent` | 事件名 | -| callback | (res: MapEventMarkerClusterCreate or MapEventMarkerClusterClick) => void | 事件的回调函数 | - -#### 示例代码 - -```tsx -MapContext.on('markerClusterCreate', (res) => {}) -MapContext.on('markerClusterClick', (res) => {}) -``` - -## 参数 - -### GetCenterLocationOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetCenterLocationSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetCenterLocationSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| latitude | `number` | 纬度 | -| longitude | `number` | 经度 | -| errMsg | `string` | 调用结果 | - -### SetLocMarkerIconOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| iconPath | `string` | 是 | 图标路径，支持网络路径、本地路径、代码包路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetRegionOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetRegionSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetRegionSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| northeast | `MapPosition` | 东北角经纬度 | -| southwest | `MapPosition` | 西南角经纬度 | - -### GetRotateOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetRotateSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetRotateSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| rotate | `number` | 旋转角 | -| errMsg | `string` | 调用结果 | - -### GetScaleOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetScaleSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetScaleSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scale | `number` | 缩放值 | -| errMsg | `string` | 调用结果 | - -### GetSkewOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetSkewSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### GetSkewSuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| skew | `number` | 倾斜角 | -| errMsg | `string` | 调用结果 | - -### IncludePointsOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| points | `MapPosition[]` | 是 | 要显示在可视区域内的坐标点列表 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| padding | `number[]` | 否 | 坐标点形成的矩形边缘到地图边缘的距离，单位像素。格式为[上,右,下,左]，安卓上只能识别数组第一项，上下左右的padding一致。开发者工具暂不支持padding参数。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### MapPosition - -坐标点 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| latitude | `number` | 纬度 | -| longitude | `number` | 经度 | - -### MapBoundary - -经纬度范围 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| southwest | `MapPosition` | 西南角经纬度 | -| northeast | `MapPosition` | 东北角经纬度 | - -### MoveToLocationOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| latitude | `number` | 否 | 纬度 | -| longitude | `number` | 否 | 经度 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### TranslateMarkerOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| autoRotate | `boolean` | 是 | 移动过程中是否自动旋转 marker | -| destination | `MapPosition` | 是 | 指定 marker 移动到的目标点 | -| markerId | `number` | 是 | 指定 marker | -| rotate | `number` | 是 | marker 的旋转角度 | -| animationEnd | `(...args: any[]) => any` | 否 | 动画结束回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| duration | `number` | 否 | 动画持续时长，平移与旋转分别计算 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SetCenterOffsetOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| offset | `number[]` | 是 | 偏移量，两位数组 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RemoveCustomLayerOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| layerId | `number` | 是 | 个性化图层id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AddCustomLayerOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| layerId | `number` | 是 | 个性化图层id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AddGroundLayerOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| id | `number` | | 是 | 图片图层 id | -| src | `string` | | 是 | 图片路径，支持网络图片、临时路径、代码包路径 | -| bounds | `MapBoundary` | | 是 | 图片覆盖的经纬度范围 | -| visible | `boolean` | `true` | 否 | 是否可见 | -| zIndex | `number` | `1` | 否 | 图层绘制顺序 | -| opacity | `number` | `1` | 否 | 图层透明度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### AddVisualLayerOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| layerId | `number` | | 是 | 个性化图层id（[创建图层指引](https://lbs.qq.com/dev/console/layers/layerEdit)) | -| interval | `number` | `0` | 否 | 刷新周期，单位秒 | -| zIndex | `number` | `1` | 否 | 图层绘制顺序 | -| opacity | `number` | `1` | 否 | 图层透明度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RemoveVisualLayerOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| layerId | `number` | 是 | 可视化图层 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AddArcOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| id | `number` | | 是 | 圆弧 id | -| start | `MapPosition` | | 是 | 起始点 | -| end | `MapPosition` | | 是 | 终点 | -| pass | `MapPosition` | | 否 | 途经点 | -| angle | `number` | `0` | 否 | 夹角角度 | -| width | `number` | `5` | 否 | 线宽 | -| color | `string` | `"#000000"` | 否 | 线的颜色 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RemoveArcOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| id | `number` | 是 | 圆弧 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SetBoundaryOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| southwest | `MapPosition` | 是 | 西南角经纬度 | -| northeast | `MapPosition` | 是 | 东北角经纬度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### UpdateGroundOverlayOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| id | `number` | | 是 | 图片图层 id | -| src | `string` | | 是 | 图片路径，支持网络图片、临时路径、代码包路径 | -| bounds | `MapBoundary` | | 是 | 图片覆盖的经纬度范围 | -| visible | `boolean` | `true` | 否 | 是否可见 | -| zIndex | `number` | `1` | 否 | 图层绘制顺序 | -| opacity | `number` | `1` | 否 | 图层透明度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RemoveGroundOverlayOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| id | `number` | 是 | 图片图层 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### ToScreenLocationOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| latitude | `number` | 是 | 纬度 | -| longitude | `number` | 是 | 经度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FromScreenLocationOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| x | `number` | 是 | x 坐标值 | -| y | `number` | 是 | y 坐标值 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### OpenMapAppOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| longitude | `number` | 是 | 目的地经度 | -| latitude | `number` | 是 | 目的地纬度 | -| destination | `string` | 是 | 目的地名称 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AddMarkersOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| markers | `MapProps.marker[]` | | 是 | 同传入 map 组件的 marker 属性 | -| clear | `boolean` | `false` | 否 | 是否先清空地图上所有 marker | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RemoveMarkersOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| markerIds | `string[]` | 是 | marker 的 id 集合。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### InitMarkerClusterOption - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| enableDefaultStyle | `boolean` | `true` | 否 | 启用默认的聚合样式 | -| zoomOnClick | `boolean` | `true` | 否 | 点击已经聚合的标记点时是否实现聚合分离 | -| gridSize | `number` | `60` | 否 | 聚合算法的可聚合距离，即距离小于该值的点会聚合至一起，以像素为单位 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### MapEvent - -event 的合法值 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| markerClusterCreate | `MapEventMarkerClusterCreate` | 缩放或拖动导致新的聚合簇产生时触发，仅返回新创建的聚合簇信息 | -| markerClusterClick | `MapEventMarkerClusterClick` | 聚合簇的点击事件 | - -### MapEventMarkerClusterCreate - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| clusters | `ClusterInfo[]` | 聚合簇数据 | - -### MapEventMarkerClusterClick - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cluster | `ClusterInfo` | 聚合簇 | - -### ClusterInfo - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| clusterId | `number` | 聚合簇的 id | -| center | `LatLng` | 聚合簇的坐标 | -| markerIds | `string[]` | 该聚合簇内的点标记数据数组 | - -### LatLng - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| lat | `number` | 纬度值 | -| lng | `number` | 经度值 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| MapContext | ✔️ | ✔️ | | | | -| MapContext.getCenterLocation | ✔️ | ✔️ | | | | -| MapContext.setLocMarkerIcon | ✔️ | ✔️ | | | | -| MapContext.moveToLocation | ✔️ | ✔️ | | | | -| MapContext.translateMarker | ✔️ | ✔️ | | | | -| MapContext.includePoints | ✔️ | ✔️ | | | | -| MapContext.getRegion | ✔️ | ✔️ | | | | -| MapContext.getRotate | ✔️ | ✔️ | | | | -| MapContext.getSkew | ✔️ | ✔️ | | | | -| MapContext.getScale | ✔️ | ✔️ | | | | -| MapContext.setCenterOffset | ✔️ | ✔️ | | | | -| MapContext.removeCustomLayer | ✔️ | | | | | -| MapContext.addCustomLayer | ✔️ | | | | | -| MapContext.addGroundOverlay | ✔️ | ✔️ | | | | -| MapContext.addVisualLayer | ✔️ | | | | | -| MapContext.removeVisualLayer | ✔️ | | | | | -| MapContext.addArc | ✔️ | | | | | -| MapContext.removeArc | ✔️ | | | | | -| MapContext.setBoundary | ✔️ | | | | | -| MapContext.updateGroundOverlay | ✔️ | ✔️ | | | | -| MapContext.removeGroundOverlay | ✔️ | ✔️ | | | | -| MapContext.toScreenLocation | ✔️ | | | | | -| MapContext.fromScreenLocation | ✔️ | | | | | -| MapContext.openMapApp | ✔️ | | | | | -| MapContext.addMarkers | ✔️ | | | | | -| MapContext.removeMarkers | ✔️ | | | | | -| MapContext.initMarkerCluster | ✔️ | | | | | -| MapContext.on | ✔️ | | | | | diff --git a/versioned_docs/version-4.x/apis/media/map/createMapContext.md b/versioned_docs/version-4.x/apis/media/map/createMapContext.md deleted file mode 100644 index 7cc7c269224a..000000000000 --- a/versioned_docs/version-4.x/apis/media/map/createMapContext.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.createMapContext(mapId, component) -sidebar_label: createMapContext ---- - -创建 [map](/docs/components/maps/map) 上下文 [MapContext](/docs/apis/media/map/MapContext) 对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/map/wx.createMapContext.html) - -## 类型 - -```tsx -(mapId: string, component?: TaroGeneral.IAnyObject) => MapContext -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mapId | `string` | Map 组件的 id | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 Map 组件 | - -## 示例代码 - -```tsx -const mapCtx = Taro.createMapContext('myMap') -``` diff --git a/versioned_docs/version-4.x/apis/media/media-recorder/MediaRecorder.md b/versioned_docs/version-4.x/apis/media/media-recorder/MediaRecorder.md deleted file mode 100644 index 3bd8039db0e9..000000000000 --- a/versioned_docs/version-4.x/apis/media/media-recorder/MediaRecorder.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: MediaRecorder -sidebar_label: MediaRecorder ---- - -## 方法 - -### destroy - -销毁录制器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.destroy.html) - -```tsx -() => Promise -``` - -### off - -取消监听录制事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.off.html) - -```tsx -(eventName: keyof EventName, callback: Callback) => Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `keyof EventName` | 事件名 | -| callback | `Callback` | 事件触发时执行的回调函数 | - -### on - -注册监听录制事件的回调函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.on.html) - -```tsx -(eventName: keyof EventName, callback: Callback) => Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `keyof EventName` | 事件名 | -| callback | `Callback` | 事件触发时执行的回调函数 | - -### pause - -暂停录制 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.pause.html) - -```tsx -() => Promise -``` - -### requestFrame - -请求下一帧录制，在 callback 里完成一帧渲染后开始录制当前帧 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.requestFrame.html) - -```tsx -(callback: Callback) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### resume - -恢复录制 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.resume.html) - -```tsx -() => Promise -``` - -### start - -开始录制 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.start.html) - -```tsx -() => Promise -``` - -### stop - -结束录制 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/MediaRecorder.stop.html) - -```tsx -() => Promise -``` - -## 参数 - -### on - -#### EventName - -eventName 的合法值 - -| 参数 | 说明 | -| --- | --- | -| start | 录制开始事件。 | -| stop | 录制结束事件。返回 {tempFilePath, duration, fileSize} | -| pause | 录制暂停事件。 | -| resume | 录制继续事件。 | -| timeupdate | 录制时间更新事件。 | - -#### Callback - -事件触发时执行的回调函数 - -```tsx -(res: { tempFilePath: string; duration: number; fileSize: number; }) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `{ tempFilePath: string; duration: number; fileSize: number; }` | - -### requestFrame - -#### Callback - -事件触发时执行的回调函数 - -```tsx -() => void -``` - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MediaRecorder.destroy | ✔️ | | | | -| MediaRecorder.off | ✔️ | | | | -| MediaRecorder.on | ✔️ | | | | -| MediaRecorder.pause | ✔️ | | | | -| MediaRecorder.requestFrame | ✔️ | | | | -| MediaRecorder.resume | ✔️ | | | | -| MediaRecorder.start | ✔️ | | | | -| MediaRecorder.stop | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/media-recorder/createMediaRecorder.md b/versioned_docs/version-4.x/apis/media/media-recorder/createMediaRecorder.md deleted file mode 100644 index a2a67668afa8..000000000000 --- a/versioned_docs/version-4.x/apis/media/media-recorder/createMediaRecorder.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.createMediaRecorder(canvas, option) -sidebar_label: createMediaRecorder ---- - -创建 WebGL 画面录制器，可逐帧录制在 WebGL 上渲染的画面并导出视频文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/media-recorder/wx.createMediaRecorder.html) - -## 类型 - -```tsx -(canvas?: any, option?: Option) => MediaRecorder -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| canvas | `any` | -| option | `Option` | - -### Option - -createMediaRecorder Option - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/media-recorder/wx.createMediaRecorder.html) - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| duration | `number` | `600` | 否 | 指定录制的时长（s)，到达自动停止。最大 7200，最小 5 | -| videoBitsPerSecond | `number` | `1000` | 否 | 视频比特率（kbps），最小值 600，最大值 3000 | -| gop | `number` | `12` | 否 | 视频关键帧间隔 | -| fps | `number` | `24` | 否 | 视频 fps | diff --git a/versioned_docs/version-4.x/apis/media/recorder/RecorderManager.md b/versioned_docs/version-4.x/apis/media/recorder/RecorderManager.md deleted file mode 100644 index de3ef18a2679..000000000000 --- a/versioned_docs/version-4.x/apis/media/recorder/RecorderManager.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -title: RecorderManager -sidebar_label: RecorderManager ---- - -全局唯一的录音管理器 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.html) - -## 方法 - -### onError - -监听录音错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnErrorCallback` | 录音错误事件的回调函数 | - -### onFrameRecorded - -监听已录制完指定帧大小的文件事件。如果设置了 frameSize，则会回调此事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onFrameRecorded.html) - -```tsx -(callback: OnFrameRecordedCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnFrameRecordedCallback` | 已录制完指定帧大小的文件事件的回调函数 | - -### onInterruptionBegin - -监听录音因为受到系统占用而被中断开始事件。以下场景会触发此事件：微信语音聊天、微信视频聊天。此事件触发后，录音会被暂停。pause 事件在此事件后触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onInterruptionBegin.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 录音因为受到系统占用而被中断开始事件的回调函数 | - -### onInterruptionEnd - -监听录音中断结束事件。在收到 interruptionBegin 事件之后，小程序内所有录音会暂停，收到此事件之后才可再次录音成功。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onInterruptionEnd.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 录音中断结束事件的回调函数 | - -### onPause - -监听录音暂停事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onPause.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 录音暂停事件的回调函数 | - -### onResume - -监听录音继续事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onResume.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 录音继续事件的回调函数 | - -### onStart - -监听录音开始事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onStart.html) - -```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 录音开始事件的回调函数 | - -### onStop - -监听录音结束事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onStop.html) - -```tsx -(callback: OnStopCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnStopCallback` | 录音结束事件的回调函数 | - -### pause - -暂停录音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.pause.html) - -```tsx -() => void -``` - -### resume - -继续录音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.resume.html) - -```tsx -() => void -``` - -### start - -开始录音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.start.html) - -```tsx -(option: StartOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StartOption` | - -### stop - -停止录音 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.stop.html) - -```tsx -() => void -``` - -## 参数 - -### OnErrorCallback - -录音错误事件的回调函数 - -```tsx -(result: OnErrorCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnErrorCallbackResult` | - -### OnErrorCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -### OnFrameRecordedCallback - -已录制完指定帧大小的文件事件的回调函数 - -```tsx -(result: OnFrameRecordedCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnFrameRecordedCallbackResult` | - -### OnFrameRecordedCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| frameBuffer | `ArrayBuffer` | 录音分片数据 | -| isLastFrame | `boolean` | 当前帧是否正常录音结束前的最后一帧 | - -### OnStopCallback - -录音结束事件的回调函数 - -```tsx -(result: OnStopCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnStopCallbackResult` | - -### OnStopCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| duration | `number` | 录音总时长，单位：ms | -| fileSize | `number` | 录音文件大小，单位：Byte | -| tempFilePath | `string` | 录音文件的临时路径 | - -### StartOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| audioSource | `keyof AudioSource` | 否 | 指定录音的音频输入源，可通过 [Taro.getAvailableAudioSources()](/docs/apis/media/audio/getAvailableAudioSources) 获取当前可用的音频源 | -| duration | `number` | 否 | 录音的时长，单位 ms，最大值 600000（10 分钟） | -| encodeBitRate | `number` | 否 | 编码码率，有效值见下表格 | -| format | `keyof Format` | 否 | 音频格式 | -| frameSize | `number` | 否 | 指定帧大小，单位 KB。传入 frameSize 后，每录制指定帧大小的内容后，会回调录制的文件内容，不指定则不会回调。暂仅支持 mp3 格式。 | -| numberOfChannels | `keyof NumberOfChannels` | 否 | 录音通道数 | -| sampleRate | `keyof SampleRate` | 否 | 采样率 | - -### AudioSource - -指定录音的音频输入源 - -| 参数 | 说明 | -| --- | --- | -| auto | 自动设置，默认使用手机麦克风，插上耳麦后自动切换使用耳机麦克风，所有平台适用 | -| buildInMic | 手机麦克风，仅限 iOS | -| headsetMic | 耳机麦克风，仅限 iOS | -| mic | 麦克风（没插耳麦时是手机麦克风，插耳麦时是耳机麦克风），仅限 Android | -| camcorder | 同 mic，适用于录制音视频内容，仅限 Android | -| voice_communication | 同 mic，适用于实时沟通，仅限 Android | -| voice_recognition | 同 mic，适用于语音识别，仅限 Android | - -### Format - -音频格式 - -| 参数 | 说明 | -| --- | --- | -| mp3 | mp3 格式 | -| aac | aac 格式 | -| wav | wav 格式 | -| PCM | pcm 格式 | - -### NumberOfChannels - -录音通道数 - -| 参数 | 说明 | -| --- | --- | -| 1 | 1 个通道 | -| 2 | 2 个通道 | - -### SampleRate - -采样率 - -| 参数 | 说明 | 编码码率 | -| --- | --- | --- | -| 8000 | 8000 采样率 | `16000 ~ 48000` | -| 11025 | 11025 采样率 | `16000 ~ 48000` | -| 12000 | 12000 采样率 | `24000 ~ 64000` | -| 16000 | 16000 采样率 | `24000 ~ 96000` | -| 22050 | 22050 采样率 | `32000 ~ 128000` | -| 24000 | 24000 采样率 | `32000 ~ 128000` | -| 32000 | 32000 采样率 | `48000 ~ 192000` | -| 44100 | 44100 采样率 | `64000 ~ 320000` | -| 48000 | 48000 采样率 | `64000 ~ 320000` | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| RecorderManager.onError | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.onFrameRecorded | ✔️ | ✔️ | | | | -| RecorderManager.onInterruptionBegin | ✔️ | | | | | -| RecorderManager.onInterruptionEnd | ✔️ | | | | | -| RecorderManager.onPause | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.onResume | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.onStart | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.onStop | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.pause | ✔️ | | | ✔️ | | -| RecorderManager.resume | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.start | ✔️ | ✔️ | | ✔️ | | -| RecorderManager.stop | ✔️ | ✔️ | | ✔️ | | diff --git a/versioned_docs/version-4.x/apis/media/recorder/getRecorderManager.md b/versioned_docs/version-4.x/apis/media/recorder/getRecorderManager.md deleted file mode 100644 index 6a193bf4b975..000000000000 --- a/versioned_docs/version-4.x/apis/media/recorder/getRecorderManager.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.getRecorderManager() -sidebar_label: getRecorderManager ---- - -获取**全局唯一**的录音管理器 RecorderManager - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.getRecorderManager.html) - -## 类型 - -```tsx -() => RecorderManager -``` - -## 示例代码 - -```tsx -const recorderManager = Taro.getRecorderManager() -recorderManager.onStart(() => { - console.log('recorder start') -}) -recorderManager.onPause(() => { - console.log('recorder pause') -}) -recorderManager.onStop((res) => { - console.log('recorder stop', res) - const { tempFilePath } = res -}) -recorderManager.onFrameRecorded((res) => { - const { frameBuffer } = res - console.log('frameBuffer.byteLength', frameBuffer.byteLength) -}) -const options = { - duration: 10000, - sampleRate: 44100, - numberOfChannels: 1, - encodeBitRate: 192000, - format: 'aac', - frameSize: 50 -} -recorderManager.start(options) -``` diff --git a/versioned_docs/version-4.x/apis/media/recorder/startRecord.md b/versioned_docs/version-4.x/apis/media/recorder/startRecord.md deleted file mode 100644 index 364ee586cc8a..000000000000 --- a/versioned_docs/version-4.x/apis/media/recorder/startRecord.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Taro.startRecord(option) -sidebar_label: startRecord ---- - -开始录音。当主动调用`Taro.stopRecord`，或者录音超过1分钟时自动结束录音，返回录音文件的临时文件路径。当用户离开小程序时，此接口无法调用。 -**注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.getRecorderManager](/docs/apis/media/recorder/getRecorderManager) 接口** -需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.record - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.startRecord.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 录音文件的临时路径 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.startRecord({ - success: function (res) { - const tempFilePath = res.tempFilePath - } -}) -setTimeout(function () { - Taro.stopRecord() // 结束录音 -}, 10000) -``` diff --git a/versioned_docs/version-4.x/apis/media/recorder/stopRecord.md b/versioned_docs/version-4.x/apis/media/recorder/stopRecord.md deleted file mode 100644 index 469c1e9d5174..000000000000 --- a/versioned_docs/version-4.x/apis/media/recorder/stopRecord.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.stopRecord(option) -sidebar_label: stopRecord ---- - -停止录音。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/wx.stopRecord.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startRecord({ - success: function (res) { - var tempFilePath = res.tempFilePath - }, - fail: function (res) { - //录音失败 - } -}) -setTimeout(function() { - //结束录音 - Taro.stopRecord() -}, 10000) -``` diff --git a/versioned_docs/version-4.x/apis/media/video-decoder/VideoDecoder.md b/versioned_docs/version-4.x/apis/media/video-decoder/VideoDecoder.md deleted file mode 100644 index 04086319952b..000000000000 --- a/versioned_docs/version-4.x/apis/media/video-decoder/VideoDecoder.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: VideoDecoder -sidebar_label: VideoDecoder ---- - -## 方法 - -### getFrameData - -获取下一帧的解码数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.getFrameData.html) - -```tsx -() => Promise -``` - -### off - -取消监听录制事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.off.html) - -```tsx -(eventName: keyof EventName, callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `keyof EventName` | 事件名 | -| callback | `Callback` | 事件触发时执行的回调函数 | - -### on - -注册监听录制事件的回调函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.on.html) - -```tsx -(eventName: keyof EventName, callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `keyof EventName` | 事件名 | -| callback | `Callback` | 事件触发时执行的回调函数 | - -### remove - -移除解码器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.remove.html) - -```tsx -() => Promise -``` - -### seek - -跳到某个时间点解码 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.seek.html) - -```tsx -(position: number) => Promise -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| position | `number` | 跳转的解码位置，单位 ms | - -### start - -开始解码 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.start.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### stop - -停止解码 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/VideoDecoder.stop.html) - -```tsx -() => Promise -``` - -## 参数 - -### getFrameData - -#### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 帧数据宽度 | -| height | `number` | 帧数据高度 | -| data | `ArrayBuffer` | 帧数据 | -| pkPts | `number` | 帧原始 pts | -| pkDts | `number` | 帧原始 dts | - -### on - -#### EventName - -eventName 的合法值 - -| 参数 | 说明 | -| --- | --- | -| start | 开始事件。返回 {width, height} | -| stop | 结束事件。 | -| seek | seek 完成事件。 | -| bufferchange | 缓冲区变化事件。 | -| ended | 解码结束事件。 | - -#### Callback - -事件触发时执行的回调函数 - -```tsx -(res: { width: number; height: number; }) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `{ width: number; height: number; }` | - -### start - -#### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| source | `string` | | 是 | 需要解码的视频源文件。 | -| mode | `number` | `1` | 否 | 解码模式。0：按 pts 解码；1：以最快速度解码 | -| abortAudio | `boolean` | `false` | 否 | 是否不需要音频轨道 | -| abortVideo | `boolean` | `false` | 否 | 是否不需要视频轨道 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VideoDecoder.getFrameData | ✔️ | | | | -| VideoDecoder.off | ✔️ | | | | -| VideoDecoder.on | ✔️ | | | | -| VideoDecoder.remove | ✔️ | | | | -| VideoDecoder.seek | ✔️ | | | | -| VideoDecoder.start | ✔️ | | | | -| VideoDecoder.stop | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/video-decoder/createVideoDecoder.md b/versioned_docs/version-4.x/apis/media/video-decoder/createVideoDecoder.md deleted file mode 100644 index caaff08e4d60..000000000000 --- a/versioned_docs/version-4.x/apis/media/video-decoder/createVideoDecoder.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.createVideoDecoder() -sidebar_label: createVideoDecoder ---- - -创建视频解码器，可逐帧获取解码后的数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-decoder/wx.createVideoDecoder.html) - -## 类型 - -```tsx -() => VideoDecoder -``` diff --git a/versioned_docs/version-4.x/apis/media/video-processing/MediaContainer.md b/versioned_docs/version-4.x/apis/media/video-processing/MediaContainer.md deleted file mode 100644 index 7826ceae8e03..000000000000 --- a/versioned_docs/version-4.x/apis/media/video-processing/MediaContainer.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: MediaContainer -sidebar_label: MediaContainer ---- - -创建音视频处理容器，最终可将容器中的轨道合成一个视频 - -> 可通过 [Taro.createMediaContainer](./createMediaContainer) 创建 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.html) - -## 方法 - -### addTrack - -将音频或视频轨道添加到容器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.addTrack.html) - -```tsx -(track: MediaTrack) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| track | `MediaTrack` | 要添加的音频或视频轨道 | - -### destroy - -将容器销毁，释放资源 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.destroy.html) - -```tsx -() => void -``` - -### export - -将容器内的轨道合并并导出视频文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.export.html) - -```tsx -() => void -``` - -### extractDataSource - -将传入的视频源分离轨道。不会自动将轨道添加到待合成的容器里。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.extractDataSource.html) - -```tsx -(option: ExtractDataSourceOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ExtractDataSourceOption` | - -### removeTrack - -将音频或视频轨道从容器中移除 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaContainer.removeTrack.html) - -```tsx -(track: MediaTrack) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| track | `MediaTrack` | 要移除的音频或视频轨道 | - -## 参数 - -### ExtractDataSourceOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| source | `string` | 视频源地址，只支持本地文件 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MediaContainer | ✔️ | | | | -| MediaContainer.addTrack | ✔️ | | | | -| MediaContainer.destroy | ✔️ | | | | -| MediaContainer.export | ✔️ | | | | -| MediaContainer.extractDataSource | ✔️ | | | | -| MediaContainer.removeTrack | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/video-processing/MediaTrack.md b/versioned_docs/version-4.x/apis/media/video-processing/MediaTrack.md deleted file mode 100644 index b37e6edc256f..000000000000 --- a/versioned_docs/version-4.x/apis/media/video-processing/MediaTrack.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MediaTrack -sidebar_label: MediaTrack ---- - -可通过 [MediaContainer.extractDataSource](/docs/apis/media/video-processing/MediaContainer#extractdatasource) 返回。 -[MediaTrack](/docs/apis/media/video-processing/MediaTrack) 音频或视频轨道，可以对轨道进行一些操作 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/MediaTrack.html) - -## 方法 - -| 参数 | 类型 | 只读 | 说明 | -| --- | --- | :---: | --- | -| kind | `keyof Kind` | 是 | 轨道类型 | -| duration | `number` | 是 | 轨道长度 | -| volume | `number` | 否 | 音量，音频轨道下有效，可写 | - -## 参数 - -### Kind - -| 参数 | 说明 | -| --- | --- | -| audio | 音频轨道 | -| video | 视频轨道 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| MediaTrack | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/media/video-processing/createMediaContainer.md b/versioned_docs/version-4.x/apis/media/video-processing/createMediaContainer.md deleted file mode 100644 index bb38ad428967..000000000000 --- a/versioned_docs/version-4.x/apis/media/video-processing/createMediaContainer.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.createMediaContainer() -sidebar_label: createMediaContainer ---- - -创建音视频处理容器，最终可将容器中的轨道合成一个视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video-processing/wx.createMediaContainer.html) - -## 类型 - -```tsx -() => MediaContainer -``` diff --git a/versioned_docs/version-4.x/apis/media/video/VideoContext.md b/versioned_docs/version-4.x/apis/media/video/VideoContext.md deleted file mode 100644 index 017a336f2d3b..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/VideoContext.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -title: VideoContext -sidebar_label: VideoContext ---- - -VideoContext 实例，可通过 [Taro.createVideoContext](./createVideoContext) 获取。 - -VideoContext 通过 id 跟一个 video 组件绑定，操作对应的 video 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.html) - -## 方法 - -### exitBackgroundPlayback - -退出后台音频播放模式。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.exitBackgroundPlayback.html) - -```tsx -() => void -``` - -### exitFullScreen - -退出全屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.exitFullScreen.html) - -```tsx -() => void -``` - -### exitPictureInPicture - -退出小窗，该方法可在任意页面调用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.exitPictureInPicture.html) - -```tsx -(option: ExitPictureInPictureOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `ExitPictureInPictureOption` | - -### hideStatusBar - -隐藏状态栏，仅在iOS全屏下有效 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.hideStatusBar.html) - -```tsx -() => void -``` - -### pause - -暂停视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.pause.html) - -```tsx -() => void -``` - -### play - -播放视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.play.html) - -```tsx -() => void -``` - -### playbackRate - -设置倍速播放 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.playbackRate.html) - -```tsx -(rate: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| rate | `number` | 倍率，支持 0.5/0.8/1.0/1.25/1.5，2.6.3 起支持 2.0 倍速 | - -### requestBackgroundPlayback - -进入后台音频播放模式。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.requestBackgroundPlayback.html) - -```tsx -() => void -``` - -### requestFullScreen - -进入全屏 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.requestFullScreen.html) - -```tsx -(option: RequestFullScreenOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `RequestFullScreenOption` | - -### seek - -跳转到指定位置 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.seek.html) - -```tsx -(position: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| position | `number` | 跳转到的位置，单位 s | - -### sendDanmu - -发送弹幕 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.sendDanmu.html) - -```tsx -(data: Danmu) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `Danmu` | 弹幕内容 | - -### showStatusBar - -显示状态栏，仅在iOS全屏下有效 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.showStatusBar.html) - -```tsx -() => void -``` - -### stop - -停止视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/VideoContext.stop.html) - -```tsx -() => void -``` - -## 参数 - -### ExitPictureInPictureOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### RequestFullScreenOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| direction | 0 or 90 or -90 | 否 | 设置全屏时视频的方向，不指定则根据宽高比自动判断。

可选值：
- 0: 正常竖向;
- 90: 屏幕逆时针90度;
- -90: 屏幕顺时针90度; | - -### Danmu - -弹幕内容 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| text | `string` | 是 | 弹幕文字 | -| color | `string` | 否 | 弹幕颜色 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| VideoContext | ✔️ | ✔️ | ✔️ | | -| VideoContext.exitBackgroundPlayback | ✔️ | | | | -| VideoContext.exitFullScreen | ✔️ | ✔️ | ✔️ | | -| VideoContext.exitPictureInPicture | ✔️ | | | | -| VideoContext.hideStatusBar | ✔️ | | | | -| VideoContext.pause | ✔️ | ✔️ | ✔️ | | -| VideoContext.play | ✔️ | ✔️ | ✔️ | | -| VideoContext.playbackRate | ✔️ | ✔️ | ✔️ | | -| VideoContext.requestBackgroundPlayback | ✔️ | | | | -| VideoContext.requestFullScreen | ✔️ | ✔️ | ✔️ | | -| VideoContext.seek | ✔️ | ✔️ | ✔️ | | -| VideoContext.sendDanmu | ✔️ | | | | -| VideoContext.showStatusBar | ✔️ | | | | -| VideoContext.stop | ✔️ | ✔️ | ✔️ | | diff --git a/versioned_docs/version-4.x/apis/media/video/chooseMedia.md b/versioned_docs/version-4.x/apis/media/video/chooseMedia.md deleted file mode 100644 index 9c762fb99cde..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/chooseMedia.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Taro.chooseMedia(option) -sidebar_label: chooseMedia ---- - -拍摄或从手机相册中选择图片或视频。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| count | `number` | `9` | 否 | 最多可以选择的文件个数
API 支持度: weapp, h5 | -| mediaType | `(keyof mediaType)[]` | `['image', 'video']` | 否 | 文件类型
API 支持度: weapp, h5 | -| sourceType | `(keyof sourceType)[]` | `['album', 'camera']` | 否 | 图片和视频选择的来源
API 支持度: weapp, h5 | -| maxDuration | `number` | `10` | 否 | 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 60s 之间
API 支持度: weapp | -| sizeType | ("original" or "compressed")[] | `['original', 'compressed']` | 否 | 是否压缩所选文件
API 支持度: weapp | -| camera | `string` | `"back"` | 否 | 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头
API 支持度: weapp, h5 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| mediaId | `string` | | 否 | 用来上传的input元素ID
API 支持度: h5 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFiles | `ChooseMedia[]` | 本地临时文件列表 | -| type | `string` | 文件类型，有效值有 image 、video、mix | - -### ChooseMedia - -本地临时文件列表 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tempFilePath | `string` | 是 | 本地临时文件路径 (本地路径) | -| size | `number` | 是 | 本地临时文件大小，单位 B | -| duration | `number` | 是 | 视频的时间长度 | -| height | `number` | 是 | 视频的高度 | -| width | `number` | 是 | 视频的宽度 | -| thumbTempFilePath | `string` | 是 | 视频缩略图临时文件路径 | -| fileType | `string` | 是 | 选择的文件的类型 | -| originalFileObj | `File` | 否 | 原始的浏览器 File 对象
API 支持度: h5 | - -### mediaType - -| 参数 | 说明 | -| --- | --- | -| video | 只能拍摄视频或从相册选择视频 | -| image | 只能拍摄图片或从相册选择图片 | -| mix | 可同时选择图片和视频 | - -### sourceType - -| 参数 | 说明 | -| --- | --- | -| album | 从相册选择 | -| camera | 使用相机拍摄 | - -### camera - -| 参数 | 说明 | -| --- | --- | -| back | 使用后置摄像头 | -| front | 使用前置摄像头 | - -## 示例代码 - -```tsx -Taro.chooseMedia({ - count: 9, - mediaType: ['image','video'], - sourceType: ['album', 'camera'], - maxDuration: 30, - camera: 'back', - success: (res) => { - console.log(res.tempFiles) - console.log(res.type) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/video/chooseVideo.md b/versioned_docs/version-4.x/apis/media/video/chooseVideo.md deleted file mode 100644 index b55bdf720c80..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/chooseVideo.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Taro.chooseVideo(option) -sidebar_label: chooseVideo ---- - -拍摄视频或从手机相册中选视频。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseVideo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| camera | `keyof Camera` | `"back"` | 否 | 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效
API 支持度: weapp, h5 | -| compressed | `boolean` | `true` | 否 | 是否压缩所选择的视频文件
API 支持度: weapp | -| maxDuration | `number` | `60` | 否 | 拍摄视频最长拍摄时间，单位秒
API 支持度: weapp | -| sourceType | `(keyof sourceType)[]` | `['album', 'camera']` | 否 | 视频选择的来源
API 支持度: weapp, h5 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 选定视频的临时文件路径 | -| duration | `number` | 选定视频的时间长度 | -| size | `number` | 选定视频的数据量大小 | -| height | `number` | 返回选定视频的高度 | -| width | `number` | 返回选定视频的宽度 | -| errMsg | `string` | 调用结果 | - -### Camera - -| 参数 | 说明 | -| --- | --- | -| back | 默认拉起后置摄像头 | -| front | 默认拉起前置摄像头 | - -### sourceType - -| 参数 | 说明 | -| --- | --- | -| album | 从相册选择视频 | -| camera | 使用相机拍摄视频 | - -## 示例代码 - -```tsx -Taro.chooseVideo({ - sourceType: ['album','camera'], - maxDuration: 60, - camera: 'back', - success: function (res) { - console.log(res.tempFilePath) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/video/compressVideo.md b/versioned_docs/version-4.x/apis/media/video/compressVideo.md deleted file mode 100644 index 10c008c2b410..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/compressVideo.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Taro.compressVideo(option) -sidebar_label: compressVideo ---- - -压缩视频接口。 -开发者可指定压缩质量 `quality` 进行压缩。当需要更精细的控制时，可指定 `bitrate`、`fps`、和 `resolution`，当 `quality` 传入时，这三个参数将被忽略。原视频的相关信息可通过 [getVideoInfo](/docs/apis/media/video/getVideoInfo) 获取。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.compressVideo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 视频文件路径，可以是临时文件路径也可以是永久文件路径 | -| quality | `keyof Quality` | 是 | 压缩质量 | -| bitrate | `number` | 是 | 码率，单位 kbps | -| fps | `number` | 是 | 帧率 | -| resolution | `number` | 是 | 相对于原视频的分辨率比例，取值范围(0, 1] | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 压缩后的临时文件地址 | -| size | `number` | 压缩后的大小，单位 kB | - -### Quality - -| 参数 | 说明 | -| --- | --- | -| low | 低 | -| medium | 中 | -| high | 高 | - -## 示例代码 - -```tsx -Taro.chooseVideo({ - sourceType: ['album', 'camera'], - maxDuration: 60, - camera: 'back', - compressed: false, - success (res) { - Taro.compressVideo({ - src: res.tempFilePath, - quality: quality, - bitrate: 1032, - fps: 24, - resolution:0.5, - success (res) { - console.log("压缩成功") - }, - fail (err) { - console.log("压缩失败") - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/video/createVideoContext.md b/versioned_docs/version-4.x/apis/media/video/createVideoContext.md deleted file mode 100644 index 0b3cf25ec562..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/createVideoContext.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.createVideoContext(id, component) -sidebar_label: createVideoContext ---- - -创建 video 上下文 VideoContext 对象。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.createVideoContext.html) - -## 类型 - -```tsx -(id: string, component?: TaroGeneral.IAnyObject) => VideoContext -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `string` | video 组件的 id | -| component | `TaroGeneral.IAnyObject` | 在自定义组件下，当前组件实例的this，以操作组件内 video 组件 | - -## 示例代码 - -```tsx -videoContext = Taro.createVideoContext('myVideo') -``` diff --git a/versioned_docs/version-4.x/apis/media/video/getVideoInfo.md b/versioned_docs/version-4.x/apis/media/video/getVideoInfo.md deleted file mode 100644 index 8369c16b601c..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/getVideoInfo.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Taro.getVideoInfo(option) -sidebar_label: getVideoInfo ---- - -获取视频详细信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.getVideoInfo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| src | `string` | 是 | 视频文件路径，可以是临时文件路径也可以是永久文件路径 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| orientation | `keyof Orientation` | 画面方向 | -| type | `string` | 视频格式 | -| duration | `number` | 视频长度 | -| size | `number` | 视频大小，单位 kB | -| height | `number` | 视频的长，单位 px | -| width | `number` | 视频的宽，单位 px | -| fps | `number` | 视频帧率 | -| bitrate | `number` | 视频码率，单位 kbps | - -### Orientation - -| 参数 | 说明 | -| --- | --- | -| up | 默认 | -| down | 180 度旋转 | -| left | 逆时针旋转 90 度 | -| right | 顺时针旋转 90 度 | -| up-mirrored | 同 up，但水平翻转 | -| down-mirrored | 同 down，但水平翻转 | -| left-mirrored | 同 left，但垂直翻转 | -| right-mirrored | 同 right，但垂直翻转 | - -## 示例代码 - -```tsx -Taro.downloadFile({ - url: 'https://mock.taro.org/mock_video.mp4', - success(res) { - Taro.getVideoInfo({ - src: res.tempFilePath, - success (res) { - console.log('获取文件地址成功') - console.log(res) - }, - fail (res) { - console.log('获取文件地址失败') - console.log(res) - }, - complete (res) { - console.log('获取文件地址') - } - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/video/openVideoEditor.md b/versioned_docs/version-4.x/apis/media/video/openVideoEditor.md deleted file mode 100644 index 73a6e2d06d99..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/openVideoEditor.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.openVideoEditor(option) -sidebar_label: openVideoEditor ---- - -打开视频编辑器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.openVideoEditor.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 视频源的路径，只支持本地路径 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| duration | `number` | 剪辑后生成的视频文件的时长，单位毫秒（ms） | -| size | `number` | 剪辑后生成的视频文件大小，单位字节数（byte） | -| tempFilePath | `string` | 编辑后生成的视频文件的临时路径 | -| tempThumbPath | `string` | 编辑后生成的缩略图文件的临时路径 | - -## 示例代码 - -```tsx -Taro.openVideoEditor({ - filePath: '' -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/video/saveVideoToPhotosAlbum.md b/versioned_docs/version-4.x/apis/media/video/saveVideoToPhotosAlbum.md deleted file mode 100644 index 1fd2a6588570..000000000000 --- a/versioned_docs/version-4.x/apis/media/video/saveVideoToPhotosAlbum.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.saveVideoToPhotosAlbum(option) -sidebar_label: saveVideoToPhotosAlbum ---- - -保存视频到系统相册。支持mp4视频格式。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum - -**Bug & Tip：** - -1. `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.saveVideoToPhotosAlbum.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 视频文件路径，可以是临时文件路径也可以是永久文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.saveVideoToPhotosAlbum({ - filePath: 'file://xxx', - success: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/media/voip/exitVoIPChat.md b/versioned_docs/version-4.x/apis/media/voip/exitVoIPChat.md deleted file mode 100644 index 950059671e2e..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/exitVoIPChat.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.exitVoIPChat(option) -sidebar_label: exitVoIPChat ---- - -退出（销毁）实时语音通话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.exitVoIPChat.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/voip/join1v1Chat.md b/versioned_docs/version-4.x/apis/media/voip/join1v1Chat.md deleted file mode 100644 index 24cbf84326de..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/join1v1Chat.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Taro.join1v1Chat(option) -sidebar_label: join1v1Chat ---- - -加入（创建）双人通话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.join1v1Chat.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Caller - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| nickname | `string` | 是 | 昵称 | -| headImage | `string` | 否 | 头像 | -| openid | `string` | 是 | 小程序内 openid | - -### Listener - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| nickname | `string` | 是 | 昵称 | -| headImage | `string` | 否 | 头像 | -| openid | `string` | 是 | 小程序内 openid | - -### RoomType - -| 参数 | 说明 | -| --- | --- | -| voice | 语音通话 | -| video | 视频通话 | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| caller | `Caller` | | 是 | 呼叫方信息 | -| listener | `Listener` | | 是 | 接听方信息 | -| backgroundType | `keyof ColorType` | `0` | 否 | 窗口背景色 | -| roomType | `keyof RoomType` | | 否 | 通话类型 | -| minWindowType | `keyof ColorType` | `1` | 否 | 小窗样式 | -| disableSwitchVoice | `boolean` | `false` | 否 | 不允许切换到语音通话 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### ChatErrCode - -| 参数 | 说明 | -| --- | --- | -| -20000 | 未开通双人通话 | -| -20001 | 当前设备不支持 | -| -20002 | 正在通话中 | -| -20003 | 其它小程序正在通话中 | -| -30000 | 内部系统错误 | -| -30001 | 微信缺失相机权限 | -| -30002 | 微信缺失录音权限 | -| -30003 | 小程序缺失录音权限 | -| -30004 | 小程序缺失相机权限 | -| -1 | 当前已在房间内 | -| -2 | 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 | -| -3 | 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 | -| -1000 | 系统错误 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `keyof ChatErrCode` | 错误码 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Promised - -```tsx -FailCallbackResult | SuccessCallbackResult -``` diff --git a/versioned_docs/version-4.x/apis/media/voip/joinVoIPChat.md b/versioned_docs/version-4.x/apis/media/voip/joinVoIPChat.md deleted file mode 100644 index fd566d14b9c5..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/joinVoIPChat.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: Taro.joinVoIPChat(option) -sidebar_label: joinVoIPChat ---- - -加入 (创建) 实时语音通话，更多信息可见 [实时语音指南](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/voip-chat.html) - -调用前需要用户授权 `scope.record`，若房间类型为视频房间需要用户授权 `scope.camera`。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.joinVoIPChat.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Promised - -```tsx -FailCallbackResult | SuccessCallbackResult -``` - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| roomType | `RoomType` | `"voice"` | 否 | 房间类型 | -| signature | `string` | | 是 | 签名，用于验证小游戏的身份 | -| nonceStr | `string` | | 是 | 验证所需的随机字符串 | -| timeStamp | `number` | | 是 | 验证所需的时间戳 | -| groupId | `string` | | 是 | 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 | -| muteConfig | `MuteConfig` | | 否 | 静音设置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### RoomType - -房间类型 - -| 参数 | 说明 | -| --- | --- | -| voice | 音频房间，用于语音通话 | -| video | 视频房间，结合 [voip-room](/docs/components/media/voip-room) 组件可显示成员画面 | - -### MuteConfig - -静音设置 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| muteMicrophone | `boolean` | 否 | 是否静音麦克风 | -| muteEarphone | `boolean` | 否 | 是否静音耳机 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `keyof VoipErrCode` | 错误码 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| openIdList | `string[]` | 还在实时语音通话中的成员 openId 名单 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### VoipErrCode - -Voip 错误码 - -| 参数 | 说明 | -| --- | --- | -| -1 | 当前已在房间内 | -| -2 | 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 | -| -3 | 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 | -| -1000 | 系统错误 | diff --git a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatInterrupted.md b/versioned_docs/version-4.x/apis/media/voip/offVoIPChatInterrupted.md deleted file mode 100644 index 83129841decf..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatInterrupted.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offVoIPChatInterrupted(callback) -sidebar_label: offVoIPChatInterrupted ---- - -取消监听被动断开实时语音通话事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatInterrupted.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatMembersChanged.md b/versioned_docs/version-4.x/apis/media/voip/offVoIPChatMembersChanged.md deleted file mode 100644 index b3c063e9f7b0..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatMembersChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offVoIPChatMembersChanged(callback) -sidebar_label: offVoIPChatMembersChanged ---- - -取消监听实时语音通话成员在线状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatMembersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatSpeakersChanged.md b/versioned_docs/version-4.x/apis/media/voip/offVoIPChatSpeakersChanged.md deleted file mode 100644 index 4916fdc06fe2..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatSpeakersChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offVoIPChatSpeakersChanged(callback) -sidebar_label: offVoIPChatSpeakersChanged ---- - -取消监听实时语音通话成员通话状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatStateChanged.md b/versioned_docs/version-4.x/apis/media/voip/offVoIPChatStateChanged.md deleted file mode 100644 index 1a289f0854a4..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/offVoIPChatStateChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offVoIPChatStateChanged(callback) -sidebar_label: offVoIPChatStateChanged ---- - -取消监听房间状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatStateChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/media/voip/offVoIPVideoMembersChanged.md b/versioned_docs/version-4.x/apis/media/voip/offVoIPVideoMembersChanged.md deleted file mode 100644 index 8cd6c2238a9e..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/offVoIPVideoMembersChanged.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.offVoIPVideoMembersChanged(callback) -sidebar_label: offVoIPVideoMembersChanged ---- - -取消监听实时语音通话成员视频状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPVideoMembersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | diff --git a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatInterrupted.md b/versioned_docs/version-4.x/apis/media/voip/onVoIPChatInterrupted.md deleted file mode 100644 index 5b50d1090381..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatInterrupted.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onVoIPChatInterrupted(callback) -sidebar_label: onVoIPChatInterrupted ---- - -监听被动断开实时语音通话事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatInterrupted.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| openIdList | `string[]` | 还在实时语音通话中的成员 openId 名单 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Callback - -房间状态变化事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatMembersChanged.md b/versioned_docs/version-4.x/apis/media/voip/onVoIPChatMembersChanged.md deleted file mode 100644 index b08598612454..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatMembersChanged.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onVoIPChatMembersChanged(callback) -sidebar_label: onVoIPChatMembersChanged ---- - -监听实时语音通话成员在线状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatMembersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| openIdList | `string[]` | 还在实时语音通话中的成员 openId 名单 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Callback - -房间状态变化事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatSpeakersChanged.md b/versioned_docs/version-4.x/apis/media/voip/onVoIPChatSpeakersChanged.md deleted file mode 100644 index a8229288fdc7..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatSpeakersChanged.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onVoIPChatSpeakersChanged(callback) -sidebar_label: onVoIPChatSpeakersChanged ---- - -监听实时语音通话成员通话状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatSpeakersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| openIdList | `string[]` | 还在实时语音通话中的成员 openId 名单 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Callback - -房间状态变化事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatStateChanged.md b/versioned_docs/version-4.x/apis/media/voip/onVoIPChatStateChanged.md deleted file mode 100644 index 891874336d23..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/onVoIPChatStateChanged.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Taro.onVoIPChatStateChanged(callback) -sidebar_label: onVoIPChatStateChanged ---- - -监听房间状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatStateChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| code | `number` | 事件码 | -| data | `Record` | 附加信息 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Callback - -房间状态变化事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/media/voip/onVoIPVideoMembersChanged.md b/versioned_docs/version-4.x/apis/media/voip/onVoIPVideoMembersChanged.md deleted file mode 100644 index f592a75fb34d..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/onVoIPVideoMembersChanged.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onVoIPVideoMembersChanged(callback) -sidebar_label: onVoIPVideoMembersChanged ---- - -监听实时语音通话成员视频状态变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPVideoMembersChanged.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `Callback` | - -### Result - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| openIdList | `string[]` | 开启视频的成员名单 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 调用结果 | - -### Callback - -实时语音通话成员视频状态变化事件的回调函数 - -```tsx -(res: Result) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `Result` | diff --git a/versioned_docs/version-4.x/apis/media/voip/setEnable1v1Chat.md b/versioned_docs/version-4.x/apis/media/voip/setEnable1v1Chat.md deleted file mode 100644 index 954972416e4e..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/setEnable1v1Chat.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.setEnable1v1Chat(option) -sidebar_label: setEnable1v1Chat ---- - -开启双人通话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.setEnable1v1Chat.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| enable | `boolean` | | 是 | 是否开启 | -| backgroundType | `keyof ColorType` | `0` | 否 | 窗口背景色 | -| minWindowType | `keyof ColorType` | `1` | 否 | 小窗样式 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### ColorType - -音频通话背景以及小窗模式背景 - -| 参数 | 说明 | -| --- | --- | -| 0 | #262930 | -| 1 | #FA5151 | -| 2 | #FA9D3B | -| 3 | #3D7257 | -| 4 | #1485EE | -| 5 | #6467F0 | diff --git a/versioned_docs/version-4.x/apis/media/voip/subscribeVoIPVideoMembers.md b/versioned_docs/version-4.x/apis/media/voip/subscribeVoIPVideoMembers.md deleted file mode 100644 index 0d5a6df77039..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/subscribeVoIPVideoMembers.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.subscribeVoIPVideoMembers(option) -sidebar_label: subscribeVoIPVideoMembers ---- - -订阅视频画面成员 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.subscribeVoIPVideoMembers.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| openIdList | `string[]` | 是 | 订阅的成员列表 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/media/voip/updateVoIPChatMuteConfig.md b/versioned_docs/version-4.x/apis/media/voip/updateVoIPChatMuteConfig.md deleted file mode 100644 index b8e6310b7a3c..000000000000 --- a/versioned_docs/version-4.x/apis/media/voip/updateVoIPChatMuteConfig.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.updateVoIPChatMuteConfig(option) -sidebar_label: updateVoIPChatMuteConfig ---- - -更新实时语音静音设置 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.updateVoIPChatMuteConfig.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| muteConfig | `MuteConfig` | 是 | 静音设置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### MuteConfig - -静音设置 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| muteMicrophone | `boolean` | 否 | 是否静音麦克风 | -| muteEarphone | `boolean` | 否 | 是否静音耳机 | diff --git a/versioned_docs/version-4.x/apis/navigate/exitMiniProgram.md b/versioned_docs/version-4.x/apis/navigate/exitMiniProgram.md deleted file mode 100644 index e9f1a4687698..000000000000 --- a/versioned_docs/version-4.x/apis/navigate/exitMiniProgram.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.exitMiniProgram(option) -sidebar_label: exitMiniProgram ---- - -退出当前小程序。必须有点击行为才能调用成功。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.exitMiniProgram.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.exitMiniProgram() -··· diff --git a/versioned_docs/version-4.x/apis/navigate/navigateBackMiniProgram.md b/versioned_docs/version-4.x/apis/navigate/navigateBackMiniProgram.md deleted file mode 100644 index c54a2d819ea2..000000000000 --- a/versioned_docs/version-4.x/apis/navigate/navigateBackMiniProgram.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.navigateBackMiniProgram(option) -sidebar_label: navigateBackMiniProgram ---- - -返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功 - -注意：**微信客户端 iOS 6.5.9，Android 6.5.10 及以上版本支持** - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/miniprogram-navigate/wx.navigateBackMiniProgram.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| extraData | `TaroGeneral.IAnyObject` | 否 | 需要返回给上一个小程序的数据，上一个小程序可在 `App.onShow` 中获取到这份数据。 [详情](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html)。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.navigateBackMiniProgram({ - extraData: { - foo: 'bar' - }, - success: function (res) { - // 返回成功 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/navigate/navigateToMiniProgram.md b/versioned_docs/version-4.x/apis/navigate/navigateToMiniProgram.md deleted file mode 100644 index e3c865888841..000000000000 --- a/versioned_docs/version-4.x/apis/navigate/navigateToMiniProgram.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Taro.navigateToMiniProgram(option) -sidebar_label: navigateToMiniProgram ---- - -打开另一个小程序 - -**使用限制** -##### 需要用户触发跳转 -从 2.3.0 版本开始，若用户未点击小程序页面任意位置，则开发者将无法调用此接口自动跳转至其他小程序。 -##### 需要用户确认跳转 -从 2.3.0 版本开始，在跳转至其他小程序前，将统一增加弹窗，询问是否跳转，用户确认后才可以跳转其他小程序。如果用户点击取消，则回调 `fail cancel`。 -##### 每个小程序可跳转的其他小程序数量限制为不超过 10 个 -从 2.4.0 版本以及指定日期（具体待定）开始，开发者提交新版小程序代码时，如使用了跳转其他小程序功能，则需要在代码配置中声明将要跳转的小程序名单，限定不超过 10 个，否则将无法通过审核。该名单可在发布新版时更新，不支持动态修改。配置方法详见 [小程序全局配置](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html)。调用此接口时，所跳转的 appId 必须在配置列表中，否则回调 `fail appId "${appId}" is not in navigateToMiniProgramAppIdList`。 - -**关于调试** -- 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序，但是开发者工具会校验本次调用跳转是否成功。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持) -- 开发者工具上支持被跳转的小程序处理接收参数的调试。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/miniprogram-navigate/wx.navigateToMiniProgram.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| appId | `string` | 否 | 要打开的小程序 appId | -| path | `string` | 否 | 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [Taro.onShow](#) 回调函数、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。 | -| extraData | `TaroGeneral.IAnyObject` | 否 | 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 | -| envVersion | `keyof EnvVersion` | 否 | 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。 | -| shortLink | `string` | 否 | 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### EnvVersion - -| 参数 | 说明 | -| --- | --- | -| develop | 开发版 | -| trial | 体验版 | -| release | 正式版 | - -## 示例代码 - -```tsx -Taro.navigateToMiniProgram({ - appId: '', - path: 'page/index/index?id=123', - extraData: { - foo: 'bar' - }, - envVersion: 'develop', - success: function(res) { - // 打开成功 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/navigate/openBusinessView.md b/versioned_docs/version-4.x/apis/navigate/openBusinessView.md deleted file mode 100644 index ea2b03308bdb..000000000000 --- a/versioned_docs/version-4.x/apis/navigate/openBusinessView.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: Taro.openBusinessView(option) -sidebar_label: openBusinessView ---- - -商户通过调用订单详情接口打开微信支付分小程序，引导用户查看订单详情（小程序端） - -支持情况： - -> [参考文档](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter6_1_25.shtml) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### ScoreEnableExtraData - -wxpayScoreEnable 业务参数 - -> [参考文档](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter6_1_9.shtml) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| apply_permissions_token | `string` | 用于跳转到微信侧小程序授权数据,跳转到微信侧小程序传入，有效期为1小时；apply_permissions_token可以从[《商户预授权API》](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter6_1_2.shtml)接口的返回参数中获取。
示例值：1230000109 | - -### ScoreUsedExtraData - -wxpayScoreUse 业务参数 - -> [参考文档](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter6_1_13.shtml) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mch_id | `string` | 商户号：微信支付分配的商户号。
示例值：1230000109 | -| package | `string` | 可在【创建订单】接口的返回字段package中获取。
示例值：XXXXXXXX | -| timestamp | `string` | 时间戳：生成签名时间戳，单位秒。
示例值：1530097563 | -| nonce_str | `string` | 随机字符串：生成签名随机串。由数字、大小写字母组成，长度不超过32位。
示例值：zyx53Nkey8o4bHpxTQvd8m7e92nG5mG2 | -| sign_type | `string` | 签名方式：签名类型，仅支持HMAC-SHA256。
示例值：HMAC-SHA256 | -| sign | `string` | 签名：使用字段mch_id、service_id、out_order_no、timestamp、nonce_str、sign_type按照签名生成算法计算得出的签名值。
示例值：029B52F67573D7E3BE74904BF9AEA | - -### ScoreDetailExtraData - -wxpayScoreDetail 业务参数 - -> [参考文档](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter6_1_25.shtml) - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mch_id | `string` | 商户号：微信支付分配的商户号。
示例值：1230000109 | -| service_id | `string` | 服务ID
示例值：88888888000011 | -| out_order_no | `string` | 商户服务订单号：商户系统内部服务订单号（不是交易单号）。
示例值：234323JKHDFE1243252 | -| timestamp | `string` | 时间戳：生成签名时间戳，单位秒。
示例值：1530097563 | -| nonce_str | `string` | 随机字符串：生成签名随机串。由数字、大小写字母组成，长度不超过32位。
示例值：zyx53Nkey8o4bHpxTQvd8m7e92nG5mG2 | -| sign_type | `string` | 签名方式：签名类型，仅支持HMAC-SHA256。
示例值：HMAC-SHA256 | -| sign | `string` | 签名：使用字段mch_id、service_id、out_order_no、timestamp、nonce_str、sign_type按照签名生成算法计算得出的签名值。
示例值：029B52F67573D7E3BE74904BF9AEA | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| businessType | `string` | 是 | 跳转类型：固定配置：wxpayScoreDetail
示例值：wxpayScoreDetail
memberof: Option | -| extraData | ScoreEnableExtraData or ScoreUsedExtraData or ScoreDetailExtraData | 是 | 业务参数：需要传递给支付分的业务数据 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -if (Taro.openBusinessView) { - Taro.openBusinessView({ - businessType: 'wxpayScoreDetail', - extraData: { - mch_id: '1230000109', - service_id: '88888888000011', - out_order_no: '1234323JKHDFE1243252', - timestamp: '1530097563', - nonce_str: 'zyx53Nkey8o4bHpxTQvd8m7e92nG5mG2', - sign_type: 'HMAC-SHA256', - sign: '029B52F67573D7E3BE74904BF9AEA' - }, - success() { - //dosomething - }, - fail() { - //dosomething - }, - complete() { - //dosomething - } - }); -} else { - //引导用户升级微信版本 -} -``` diff --git a/versioned_docs/version-4.x/apis/navigate/openEmbeddedMiniProgram.md b/versioned_docs/version-4.x/apis/navigate/openEmbeddedMiniProgram.md deleted file mode 100644 index 5e626d835d8a..000000000000 --- a/versioned_docs/version-4.x/apis/navigate/openEmbeddedMiniProgram.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.openEmbeddedMiniProgram(option) -sidebar_label: openEmbeddedMiniProgram ---- - -打开半屏小程序。接入指引请参考 [半屏小程序能力](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.openEmbeddedMiniProgram.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| appId | `string` | 否 | 要打开的小程序 appId | -| path | `string` | 否 | 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [Taro.onShow](#) 回调函数、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。 | -| extraData | `TaroGeneral.IAnyObject` | 否 | 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 | -| envVersion | `keyof EnvVersion` | 否 | 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。 | -| shortLink | `string` | 否 | 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 | -| verify | `keyof Verify` | 否 | 校验方式 。默认为binding | -| noRelaunchIfPathUnchanged | `boolean` | 否 | 不 reLaunch 目标小程序，直接打开目标跳转的小程序退后台时的页面，需满足以下条件：1. 目标跳转的小程序生命周期未被销毁；2. 且目标当次启动的path、query、apiCategory与上次启动相同。默认值为 false 。 | -| allowFullScreen | `boolean` | 否 | 打开的小程序是否支持全屏 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Verify - -| 参数 | 说明 | -| --- | --- | -| binding | 校验小程序管理后台的绑定关系 | -| unionProduct | 校验目标打开链接是否为小程序联盟商品。 | - -### EnvVersion - -| 参数 | 说明 | -| --- | --- | -| develop | 开发版 | -| trial | 体验版 | -| release | 正式版 | diff --git a/versioned_docs/version-4.x/apis/network/download/DownloadTask.md b/versioned_docs/version-4.x/apis/network/download/DownloadTask.md deleted file mode 100644 index 859ab11f2635..000000000000 --- a/versioned_docs/version-4.x/apis/network/download/DownloadTask.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: DownloadTask -sidebar_label: DownloadTask ---- - -一个可以监听下载进度变化事件，以及取消下载任务的对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.html) - -## 方法 - -### abort - -中断下载任务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.abort.html) - -```tsx -() => void -``` - -### onProgressUpdate - -监听下载进度变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onProgressUpdate.html) - -```tsx -(callback: OnProgressUpdateCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnProgressUpdateCallback` | 下载进度变化事件的回调函数 | - -### offProgressUpdate - -取消监听下载进度变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offProgressUpdate.html) - -```tsx -(callback: OnProgressUpdateCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnProgressUpdateCallback` | 下载进度变化事件的回调函数 | - -### onHeadersReceived - -监听 HTTP Response Header 事件。会比请求完成事件更早 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onHeadersReceived.html) - -```tsx -(callback: OnHeadersReceivedCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnHeadersReceivedCallback` | HTTP Response Header 事件的回调函数 | - -### offHeadersReceived - -取消监听 HTTP Response Header 事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offHeadersReceived.html) - -```tsx -(callback: OnHeadersReceivedCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnHeadersReceivedCallback` | HTTP Response Header 事件的回调函数 | - -## 参数 - -### OnHeadersReceivedCallback - -HTTP Response Header 事件的回调函数 - -```tsx -(result: OnHeadersReceivedCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnHeadersReceivedCallbackResult` | - -### OnProgressUpdateCallback - -下载进度变化事件的回调函数 - -```tsx -(result: OnProgressUpdateCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnProgressUpdateCallbackResult` | - -### OnHeadersReceivedCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| header | `TaroGeneral.IAnyObject` | 开发者服务器返回的 HTTP Response Header | - -### OnProgressUpdateCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| progress | `number` | 下载进度百分比 | -| totalBytesExpectedToWrite | `number` | 预期需要下载的数据总长度，单位 Bytes | -| totalBytesWritten | `number` | 已经下载的数据长度，单位 Bytes | - -### DownloadTaskPromise - -## 示例代码 - -```tsx -const downloadTask = Taro.downloadFile({ - url: 'http://example.com/audio/123', //仅为示例，并非真实的资源 - success (res) { - Taro.playVoice({ - filePath: res.tempFilePath - }) - } -}) - -downloadTask.onProgressUpdate((res) => { - console.log('下载进度', res.progress) - console.log('已经下载的数据长度', res.totalBytesWritten) - console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite) -}) - -downloadTask.abort() // 取消下载任务 -``` - -## API 支持度 - -| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| DownloadTask | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| DownloadTask.abort | ✔️ | | | ✔️ | ✔️ | | | -| DownloadTask.onProgressUpdate | ✔️ | | | ✔️ | ✔️ | | | -| DownloadTask.offProgressUpdate | ✔️ | | | ✔️ | ✔️ | | | -| DownloadTask.onHeadersReceived | ✔️ | | | | ✔️ | | | -| DownloadTask.offHeadersReceived | ✔️ | | | | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/network/download/downloadFile.md b/versioned_docs/version-4.x/apis/network/download/downloadFile.md deleted file mode 100644 index 15e357c826c2..000000000000 --- a/versioned_docs/version-4.x/apis/network/download/downloadFile.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Taro.downloadFile(option) -sidebar_label: downloadFile ---- - -下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径，单次下载允许的最大文件为 50MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -注意：请在服务端响应的 header 中指定合理的 `Content-Type` 字段，以保证客户端正确处理文件类型。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html) - -## 类型 - -```tsx -(option: Option) => DownloadTaskPromise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| url | `string` | | 是 | 下载资源的 url | -| filePath | `string` | | 否 | 指定文件下载后存储的路径 | -| header | `TaroGeneral.IAnyObject` | | 否 | HTTP 请求的 Header，Header 中不能设置 Referer | -| timeout | `number` | | 否 | 超时时间，单位为毫秒 | -| withCredentials | `boolean` | `true` | 否 | 是否应使用传出凭据 (cookie) 发送此请求
API 支持度: h5 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: FileSuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### FileSuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 用户文件路径。传入 filePath 时会返回，跟传入的 filePath 一致 | -| statusCode | `number` | 是 | 开发者服务器返回的 HTTP 状态码 | -| tempFilePath | `string` | 是 | 临时文件路径。没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件 | -| errMsg | `string` | 是 | 调用结果 | -| header | `TaroGeneral.IAnyObject` | 否 | 开发者服务器返回的 HTTP Response Header
API 支持度: weapp
weapp: 非官方文档标注属性 | -| dataLength | `number` | 否 | 数据长度，单位 Byte
API 支持度: weapp
weapp: 非官方文档标注属性 | -| cookies | `string[]` | 否 | cookies
API 支持度: weapp
weapp: 非官方文档标注属性 | -| profile | `TaroGeneral.IAnyObject` | 否 | 网络请求过程中一些调试信息 | - -## 示例代码 - -```tsx -Taro.downloadFile({ - url: 'https://example.com/audio/123', //仅为示例，并非真实的资源 - success: function (res) { - // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容 - if (res.statusCode === 200) { - Taro.playVoice({ - filePath: res.tempFilePath - }) - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceDiscoveryStop.md b/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceDiscoveryStop.md deleted file mode 100644 index 236c6e57a3ed..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceDiscoveryStop.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.offLocalServiceDiscoveryStop(callback) -sidebar_label: offLocalServiceDiscoveryStop ---- - -取消监听 mDNS 服务停止搜索的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.offLocalServiceDiscoveryStop.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务停止搜索的事件的回调函数 | - -### Callback - -mDNS 服务停止搜索的事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceFound.md b/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceFound.md deleted file mode 100644 index 369a43f13e4a..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceFound.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.offLocalServiceFound(callback) -sidebar_label: offLocalServiceFound ---- - -取消监听 mDNS 服务发现的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.offLocalServiceFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务发现的事件的回调函数 | - -### Callback - -mDNS 服务发现的事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceLost.md b/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceLost.md deleted file mode 100644 index ede3c2d575b3..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceLost.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.offLocalServiceLost(callback) -sidebar_label: offLocalServiceLost ---- - -取消监听 mDNS 服务离开的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.offLocalServiceLost.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务离开的事件的回调函数 | - -### Callback - -mDNS 服务离开的事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceResolveFail.md b/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceResolveFail.md deleted file mode 100644 index 8935a2f3f85a..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/offLocalServiceResolveFail.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.offLocalServiceResolveFail(callback) -sidebar_label: offLocalServiceResolveFail ---- - -取消监听 mDNS 服务解析失败的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.offLocalServiceResolveFail.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务解析失败的事件的回调函数 | - -### Callback - -mDNS 服务解析失败的事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceDiscoveryStop.md b/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceDiscoveryStop.md deleted file mode 100644 index 1f1711a3820a..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceDiscoveryStop.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.onLocalServiceDiscoveryStop(callback) -sidebar_label: onLocalServiceDiscoveryStop ---- - -监听 mDNS 服务停止搜索的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.onLocalServiceDiscoveryStop.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务停止搜索的事件的回调函数 | - -### Callback - -mDNS 服务停止搜索的事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceFound.md b/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceFound.md deleted file mode 100644 index 1e6ed27f72b1..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceFound.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Taro.onLocalServiceFound(callback) -sidebar_label: onLocalServiceFound ---- - -监听 mDNS 服务发现的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.onLocalServiceFound.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务发现的事件的回调函数 | - -### Callback - -mDNS 服务发现的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ip | `string` | 服务的 ip 地址 | -| port | `number` | 服务的端口 | -| serviceName | `string` | 服务的名称 | -| serviceType | `string` | 服务的类型 | diff --git a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceLost.md b/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceLost.md deleted file mode 100644 index bb1ec018483b..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceLost.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.onLocalServiceLost(callback) -sidebar_label: onLocalServiceLost ---- - -监听 mDNS 服务离开的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.onLocalServiceLost.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务离开的事件的回调函数 | - -### Callback - -mDNS 服务离开的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceName | `string` | 服务的名称 | -| serviceType | `string` | 服务的类型 | diff --git a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceResolveFail.md b/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceResolveFail.md deleted file mode 100644 index ba1573fddbd2..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/onLocalServiceResolveFail.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.onLocalServiceResolveFail(callback) -sidebar_label: onLocalServiceResolveFail ---- - -监听 mDNS 服务解析失败的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.onLocalServiceResolveFail.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | mDNS 服务解析失败的事件的回调函数 | - -### Callback - -mDNS 服务解析失败的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| serviceName | `string` | 服务的名称 | -| serviceType | `string` | 服务的类型 | diff --git a/versioned_docs/version-4.x/apis/network/mdns/startLocalServiceDiscovery.md b/versioned_docs/version-4.x/apis/network/mdns/startLocalServiceDiscovery.md deleted file mode 100644 index 2ab73b82c1d4..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/startLocalServiceDiscovery.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.startLocalServiceDiscovery(option) -sidebar_label: startLocalServiceDiscovery ---- - -开始搜索局域网下的 mDNS 服务。搜索的结果会通过 wx.onLocalService* 事件返回。 - -**注意** -1. wx.startLocalServiceDiscovery 是一个消耗性能的行为，开始 30 秒后会自动 stop 并执行 wx.onLocalServiceDiscoveryStop 注册的回调函数。 -2. 在调用 wx.startLocalServiceDiscovery 后，在这次搜索行为停止后才能发起下次 wx.startLocalServiceDiscovery。停止本次搜索行为的操作包括调用 wx.stopLocalServiceDiscovery 和 30 秒后系统自动 stop 本次搜索。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.startLocalServiceDiscovery.html) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'invalid param': serviceType 为空;
- 'scan task already exist': 在当前 startLocalServiceDiscovery 发起的搜索未停止的情况下，再次调用 startLocalServiceDiscovery; | diff --git a/versioned_docs/version-4.x/apis/network/mdns/stopLocalServiceDiscovery.md b/versioned_docs/version-4.x/apis/network/mdns/stopLocalServiceDiscovery.md deleted file mode 100644 index 3358c3cfd7b0..000000000000 --- a/versioned_docs/version-4.x/apis/network/mdns/stopLocalServiceDiscovery.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.stopLocalServiceDiscovery(option) -sidebar_label: stopLocalServiceDiscovery ---- - -停止搜索 mDNS 服务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/mdns/wx.stopLocalServiceDiscovery.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息

可选值：
- 'task not found': 在当前没有处在搜索服务中的情况下调用 stopLocalServiceDiscovery; | diff --git a/versioned_docs/version-4.x/apis/network/request/RequestTask.md b/versioned_docs/version-4.x/apis/network/request/RequestTask.md deleted file mode 100644 index b42b8b482521..000000000000 --- a/versioned_docs/version-4.x/apis/network/request/RequestTask.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -title: RequestTask -sidebar_label: RequestTask ---- - -网络请求任务对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.html) - -## 方法 - -### abort - -中断请求任务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.abort.html) - -```tsx -() => void -``` - -### onHeadersReceived - -监听 HTTP Response Header 事件。会比请求完成事件更早 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onHeadersReceived.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | HTTP Response Header 事件的回调函数 | - -### offHeadersReceived - -取消监听 HTTP Response Header 事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offHeadersReceived.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | HTTP Response Header 事件的回调函数 | - -### onChunkReceived - -监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onChunkReceived.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | Transfer-Encoding Chunk Received 事件的回调函数 | - -### offChunkReceived - -移除 Transfer-Encoding Chunk Received 事件的监听函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offChunkReceived.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | Transfer-Encoding Chunk Received 事件的回调函数 | - -## 参数 - -### onHeadersReceived - -#### Callback - -HTTP Response Header 事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| header | `TaroGeneral.IAnyObject` | 开发者服务器返回的 HTTP Response Header | - -### onChunkReceived - -#### Callback - -Transfer-Encoding Chunk Received 事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -开发者服务器每次返回新 chunk 时的 Response - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `ArrayBuffer` | 返回的chunk buffer | - -## 示例代码 - -### 示例 1 - -回调函数(Callback)用法： - -```tsx -const requestTask = Taro.request({ - url: 'test.php', //仅为示例，并非真实的接口地址 - data: { - x: '' , - y: '' - }, - header: { - 'content-type': 'application/json' // 默认值 - }, - success: function (res) { - console.log(res.data) - } -}) -requestTask.abort() -``` - -### 示例 2 - -Promise 用法： - -```tsx -const requestTask = Taro.request({ - url: 'test.php', //仅为示例，并非真实的接口地址 - data: { - x: '' , - y: '' - }, - header: { - 'content-type': 'application/json' // 默认值 - }, - success: function (res) { - console.log(res.data) - } -}) -requestTask.then(res => { - console.log(res.data) -}) -requestTask.abort() -``` - -### 示例 3 - -async/await 用法： - -```tsx -const requestTask = Taro.request(params) -const res = await requestTask -requestTask.abort() -``` - -## API 支持度 - -| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| RequestTask | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| RequestTask.abort | ✔️ | | | ✔️ | | | | | -| RequestTask.onHeadersReceived | ✔️ | | | | | | | | -| RequestTask.offHeadersReceived | ✔️ | | | | | | | | -| RequestTask.onChunkReceived | ✔️ | | | | | | | | -| RequestTask.offChunkReceived | ✔️ | | | | | | | | diff --git a/versioned_docs/version-4.x/apis/network/request/addInterceptor.md b/versioned_docs/version-4.x/apis/network/request/addInterceptor.md deleted file mode 100644 index 819024ea496c..000000000000 --- a/versioned_docs/version-4.x/apis/network/request/addInterceptor.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Taro.addInterceptor(interceptor) -sidebar_label: addInterceptor ---- - -> 最低 Taro 版本: 1.2.16 - -可以使用拦截器在请求发出前或发出后做一些额外操作。 - -在调用 `Taro.request` 发起请求之前，调用 `Taro.addInterceptor` 方法为请求添加拦截器，拦截器的调用顺序遵循洋葱模型。 -拦截器是一个函数，接受 chain 对象作为参数。chain 对象中含有 **requestParmas** 属性，代表请求参数。拦截器内最后需要调用 `chain.proceed(requestParams)` 以调用下一个拦截器或发起请求。 - -Taro 提供了两个内置拦截器 `logInterceptor` 与 `timeoutInterceptor`，分别用于打印请求的相关信息和在请求超时时抛出错误。 - -支持情况： - -## 类型 - -```tsx -(interceptor: interceptor) => any -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| interceptor | `interceptor` | - -## 示例代码 - -### 示例 1 - -```tsx -const interceptor = function (chain) { - const requestParams = chain.requestParams - const { method, data, url } = requestParams - - console.log(`http ${method || 'GET'} --> ${url} data: `, data) - - return chain.proceed(requestParams) - .then(res => { - console.log(`http <-- ${url} result:`, res) - return res - }) - } -Taro.addInterceptor(interceptor) -Taro.request({ url }) -``` - -### 示例 2 - -```tsx -Taro.addInterceptor(Taro.interceptors.logInterceptor) -Taro.addInterceptor(Taro.interceptors.timeoutInterceptor) -Taro.request({ url }) -``` diff --git a/versioned_docs/version-4.x/apis/network/request/cleanInterceptors.md b/versioned_docs/version-4.x/apis/network/request/cleanInterceptors.md deleted file mode 100644 index 3bc76a109f57..000000000000 --- a/versioned_docs/version-4.x/apis/network/request/cleanInterceptors.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.cleanInterceptors() -sidebar_label: cleanInterceptors ---- - -清除所有拦截器 - -支持情况： - -## 类型 - -```tsx -() => void -``` - -## 示例代码 - -```tsx -Taro.cleanInterceptors() -``` diff --git a/versioned_docs/version-4.x/apis/network/request/request.md b/versioned_docs/version-4.x/apis/network/request/request.md deleted file mode 100644 index 03decb0d5bec..000000000000 --- a/versioned_docs/version-4.x/apis/network/request/request.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: Taro.request(option) -sidebar_label: request ---- - -发起 HTTPS 网络请求。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -**data 参数说明** -最终发送给服务器的数据是 String 类型，如果传入的 data 不是 String 类型，会被转换成 String 。转换规则如下： -- 对于 `GET` 方法的数据，会将数据转换成 query string（`encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...`） -- 对于 `POST` 方法且 `header['content-type']` 为 `application/json` 的数据，会对数据进行 JSON 序列化 -- 对于 `POST` 方法且 `header['content-type']` 为 `application/x-www-form-urlencoded` 的数据，会将数据转换成 query string `（encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...）` - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html) - -## 类型 - -```tsx -(option: Option) => RequestTask -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `T` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| url | `string` | | 是 | 开发者服务器接口地址 | -| data | `U` | | 否 | 请求的参数 | -| header | `TaroGeneral.IAnyObject` | | 否 | 设置请求的 header，header 中不能设置 Referer。

`content-type` 默认为 `application/json` | -| timeout | `number` | `2000` | 否 | 超时时间，单位为毫秒
API 支持度: weapp, h5, tt, alipay | -| method | `keyof Method` | `"GET"` | 否 | HTTP 请求方法 | -| dataType | `string` | | 否 | 返回的数据格式 | -| responseType | `keyof ResponseType` | | 否 | 响应的数据类型 | -| enableHttp2 | `boolean` | `false` | 否 | 开启 http2
API 支持度: weapp | -| enableQuic | `boolean` | `false` | 否 | 开启 quic
API 支持度: weapp | -| enableCache | `boolean` | `false` | 否 | 开启 cache
API 支持度: weapp, tt | -| enableHttpDNS | `boolean` | `false` | 否 | 是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 移动解析HttpDNS
API 支持度: weapp | -| httpDNSServiceId | `string` | | 否 | HttpDNS 服务商 Id。 HttpDNS 用法详见 移动解析HttpDNS
API 支持度: weapp | -| enableChunked | `boolean` | `false` | 否 | 开启 transfer-encoding chunked。
API 支持度: weapp | -| forceCellularNetwork | `boolean` | `false` | 否 | wifi下使用移动网络发送请求
API 支持度: weapp | -| enableCookie | `boolean` | `false` | 否 | headers 中设置 cookie 字段是否生效。如果为 false，则 headers 中的 cookie 字段将被忽略，请求头中将包含服务端上一次返回的 cookie（如果有）。
API 支持度: alipay 支付宝: 10.2.33+ | -| referrerStrategy | `keyof ReferrerStrategy` | `"querystring"` | 否 | referer 策略，用于控制当前请求 header 对象中 referer 字段格式。该参数默认值可通过 app.json 中的配置进行修改。
API 支持度: alipay 支付宝: 10.3.50+ APPX: 2.8.7 开发者工具: 3.5.1
[参考地址](https://opendocs.alipay.com/mini/api/owycmh#referrerStrategy%20%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E) | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| jsonp | string or boolean | `false` | 否 | 设置是否使用 jsonp 方式获取数据
API 支持度: h5 | -| jsonpCache | `RequestCache` | | 否 | 设置 jsonp 请求 url 是否需要被缓存
API 支持度: h5 | -| mode | `keyof CorsMode` | `"same-origin"` | 否 | 设置是否允许跨域请求
API 支持度: h5 | -| credentials | `keyof Credentials` | `"omit"` | 否 | 设置是否携带 Cookie
API 支持度: h5 | -| cache | `keyof Cache` | `"default"` | 否 | 设置缓存模式
API 支持度: h5 | -| retryTimes | `number` | `2` | 否 | 设置请求重试次数
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| backup | string or string[] | | 否 | 设置请求的兜底接口
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| signal | `AbortSignal` | | 否 | 设置请求中止信号
API 支持度: h5 | -| dataCheck | `() => boolean` | | 否 | 设置请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| useStore | `boolean` | `false` | 否 | 设置请求是否使用缓存
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| storeCheckKey | `string` | | 否 | 设置请求缓存校验的 key
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| storeSign | `string` | | 否 | 设置请求缓存签名
API 支持度: h5
h5: 仅在 jsonp 模式下生效 | -| storeCheck | `() => boolean` | | 否 | 设置请求校验函数，一般不需要设置
API 支持度: h5 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `T` | 是 | 开发者服务器返回的数据 | -| header | `TaroGeneral.IAnyObject` | 是 | 开发者服务器返回的 HTTP Response Header | -| statusCode | `number` | 是 | 开发者服务器返回的 HTTP 状态码 | -| errMsg | `string` | 是 | 调用结果 | -| cookies | `string[]` | 否 | cookies | - -### DataType - -返回的数据格式 - -| 参数 | 说明 | -| --- | --- | -| json | 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
其他: 不对返回的内容进行 JSON.parse | -| text | 返回的数据为文本字符串
API 支持度: alipay | -| base64 | 返回的数据将转换为 base64 格式字符串
API 支持度: alipay | -| arraybuffer | 返回的数据将保持 ArrayBuffer 数据
API 支持度: alipay 支付宝: 10.1.70+ | - -### Method - -HTTP 请求方法 - -| 参数 | 说明 | -| --- | --- | -| OPTIONS | HTTP 请求 OPTIONS | -| GET | HTTP 请求 GET | -| HEAD | HTTP 请求 HEAD | -| POST | HTTP 请求 POST | -| PUT | HTTP 请求 PUT | -| PATCH | HTTP 请求 PATCH | -| DELETE | HTTP 请求 DELETE | -| TRACE | HTTP 请求 TRACE | -| CONNECT | HTTP 请求 CONNECT | - -### ResponseType - -响应的数据类型 - -| 参数 | 说明 | -| --- | --- | -| text | 响应的数据为文本 | -| arraybuffer | 响应的数据为 ArrayBuffer | - -### CorsMode - -跨域策略 - -| 参数 | 说明 | -| --- | --- | -| no-cors | 跨域请求将获取不透明的响应 | -| cors | 允许跨域请求 | -| same-origin | 请求总是向当前的源发起的 | - -### Credentials - -证书 - -| 参数 | 说明 | -| --- | --- | -| include | 不论是不是跨域的请求,总是发送请求资源域在本地的 cookies、 HTTP Basic authentication 等验证信息 | -| same-origin | 只有当URL与响应脚本同源才发送 cookies、 HTTP Basic authentication 等验证信息 | -| omit | 从不发送cookies | - -### Cache - -缓存策略 - -| 参数 | 说明 | -| --- | --- | -| default | 浏览器从HTTP缓存中寻找匹配的请求 | -| no-cache | 浏览器在其HTTP缓存中寻找匹配的请求 | -| reload | 浏览器直接从远程服务器获取资源，不查看缓存，然后使用下载的资源更新缓存 | -| force-cache | 浏览器在其HTTP缓存中寻找匹配的请求 | -| only-if-cached | 浏览器在其HTTP缓存中寻找匹配的请求 | - -### ReferrerStrategy - -referer 策略 - -| 参数 | 说明 | -| --- | --- | -| index | referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html | -| page | 保留 page（pages/xxx/yyy），referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page} | -| querystring | 默认值。会将发起请求时所在页面的 URL 作为 referer 值，会保留 page（pages/xxx/yyy）和 querystring（x=1&y=2）并可能有框架添加的其他参数，referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}?{querysrtring}{框架其他参数} | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.request({ - url: 'test.php', //仅为示例，并非真实的接口地址 - data: { - x: '', - y: '' - }, - header: { - 'content-type': 'application/json' // 默认值 - }, - success: function (res) { - console.log(res.data) - } -}) -``` - -### 示例 2 - -async/await 用法： - -```tsx -const res = await Taro.request(params) -``` diff --git a/versioned_docs/version-4.x/apis/network/tcp/TCPSocket.md b/versioned_docs/version-4.x/apis/network/tcp/TCPSocket.md deleted file mode 100644 index 620bc582a63a..000000000000 --- a/versioned_docs/version-4.x/apis/network/tcp/TCPSocket.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -title: TCPSocket -sidebar_label: TCPSocket ---- - -一个 TCP Socket 实例，默认使用 IPv4 协议 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.html) - -## 方法 - -### connect - -在给定的套接字上启动连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.connect.html) - -```tsx -(option: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -#### 示例代码 - -```tsx -const tcp = Taro.createTCPSocket() -tcp.connect({ address: '192.168.193.2', port: 8848 }) -``` - -### write - -在 socket 上发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.write.html) - -```tsx -(data: string | ArrayBuffer) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | string or ArrayBuffer | 要发送的数据 | - -#### 示例代码 - -```tsx -const tcp = Taro.createTCPSocket() -tcp.write('hello, how are you') -``` - -### close - -关闭连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.close.html) - -```tsx -() => void -``` - -#### 示例代码 - -```tsx -const tcp = Taro.createTCPSocket() -tcp.close() -``` - -### onClose - -监听关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onClose.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当一个 socket 完全关闭就发出该事件的回调函数 | - -### offClose - -取消监听当一个 socket 完全关闭就发出该事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offClose.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当一个 socket 完全关闭就发出该事件的回调函数 | - -### onConnect - -监听当一个 socket 连接成功建立的时候触发该事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onConnect.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当一个 socket 连接成功建立的时候触发该事件的回调函数 | - -### offConnect - -取消监听当一个 socket 连接成功建立的时候触发该事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offConnect.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当一个 socket 连接成功建立的时候触发该事件的回调函数 | - -### onError - -监听当错误发生时触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onError.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听当错误发生时触发的回调函数 | - -### offError - -取消监听当错误发生时触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offError.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听当错误发生时触发的回调函数 | - -### onMessage - -监听当接收到数据的时触发该事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当接收到数据的时触发该事件的回调函数 | - -### offMessage - -取消监听当接收到数据的时触发该事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 当接收到数据的时触发该事件的回调函数 | - -## 参数 - -### connect - -#### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 套接字要连接的地址 | -| port | `number` | 套接字要连接的端口 | - -### onClose - -#### Callback - -当一个 socket 完全关闭就发出该事件的回调函数 - -```tsx -(args: unknown[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `unknown[]` | - -### onConnect - -#### Callback - -当一个 socket 连接成功建立的时候触发该事件的回调函数 - -```tsx -(args: unknown[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `unknown[]` | - -### onError - -#### Callback - -监听当错误发生时触发的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -### onMessage - -#### Callback - -当接收到数据的时触发该事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| message | `ArrayBuffer` | 收到的消息 | -| remoteInfo | `RemoteInfo` | 发送端地址信息 | -| localInfo | `LocalInfo` | 接收端地址信息 | - -#### RemoteInfo - -发送端地址信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 发送消息的 socket 的地址 | -| family | `string` | 使用的协议族，为 IPv4 或者 IPv6 | -| port | `number` | 端口号 | -| size | `number` | message 的大小，单位：字节 | - -#### LocalInfo - -接收端地址信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 接收消息的 socket 的地址 | -| family | `string` | 使用的协议族，为 IPv4 或者 IPv6 | -| port | `number` | 端口号 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| TCPSocket | ✔️ | | | | -| TCPSocket.connect | ✔️ | | | | -| TCPSocket.write | ✔️ | | | | -| TCPSocket.close | ✔️ | | | | -| TCPSocket.onClose | ✔️ | | | | -| TCPSocket.offClose | ✔️ | | | | -| TCPSocket.onConnect | ✔️ | | | | -| TCPSocket.offConnect | ✔️ | | | | -| TCPSocket.onError | ✔️ | | | | -| TCPSocket.offError | ✔️ | | | | -| TCPSocket.onMessage | ✔️ | | | | -| TCPSocket.offMessage | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/network/tcp/createTCPSocket.md b/versioned_docs/version-4.x/apis/network/tcp/createTCPSocket.md deleted file mode 100644 index e034d513d4d1..000000000000 --- a/versioned_docs/version-4.x/apis/network/tcp/createTCPSocket.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Taro.createTCPSocket() -sidebar_label: createTCPSocket ---- - -创建一个 TCP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -**连接限制** - -- 允许与局域网内的非本机 IP 通信 -- 允许与配置过的服务器域名通信，详见[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html) -- 禁止与以下端口号连接：1024 以下 1099 1433 1521 1719 1720 1723 2049 2375 3128 3306 3389 3659 4045 5060 5061 5432 5984 6379 6000 6566 7001 7002 8000-8100 8443 8888 9200 9300 10051 10080 11211 27017 27018 27019 -- 每 5 分钟内最多创建 20 个 TCPSocket - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/wx.createTCPSocket.html) - -## 类型 - -```tsx -() => TCPSocket -``` diff --git a/versioned_docs/version-4.x/apis/network/udp/UDPSocket.md b/versioned_docs/version-4.x/apis/network/udp/UDPSocket.md deleted file mode 100644 index 6e4ce5f936d5..000000000000 --- a/versioned_docs/version-4.x/apis/network/udp/UDPSocket.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -title: UDPSocket -sidebar_label: UDPSocket ---- - -一个 UDP Socket 实例，默认使用 IPv4 协议。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.html) - -## 方法 - -### bind - -绑定一个系统随机分配的可用端口，或绑定一个指定的端口号 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.bind.html) - -```tsx -(port: number) => number -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| port | `number` | 指定要绑定的端口号，不传则返回系统随机分配的可用端口 | - -#### 示例代码 - -```tsx -const udp = Taro.createUDPSocket() -udp.close() -``` - -### setTTL - -设置 IP_TTL 套接字选项，用于设置一个 IP 数据包传输时允许的最大跳步数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.setTTL.html) - -```tsx -(ttl: number) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ttl | `number` | ttl 参数可以是 0 到 255 之间 | - -#### 示例代码 - -```tsx -const udp = Taro.createUDPSocket() -udp.onListening(function () { - udp.setTTL(64) -}) -udp.bind() -``` - -### send - -向指定的 IP 和 port 发送消息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.send.html) - -```tsx -(option: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -#### 示例代码 - -```tsx -const udp = Taro.createUDPSocket() -udp.bind() -udp.send({ - address: '192.168.193.2', - port: 8848, - message: 'hello, how are you' -}) -``` - -### connect - -预先连接到指定的 IP 和 port，需要配合 write 方法一起使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.connect.html) - -```tsx -(option: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### write - -用法与 send 方法相同，如果没有预先调用 connect 则与 send 无差异（注意即使调用了 connect 也需要在本接口填入地址和端口参数） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.write.html) - -```tsx -() => void -``` - -### close - -关闭 UDP Socket 实例，相当于销毁。 在关闭之后，UDP Socket 实例不能再发送消息，每次调用 `UDPSocket.send` 将会触发错误事件，并且 message 事件回调函数也不会再也执行。在 `UDPSocket` 实例被创建后将被 Native 强引用，保证其不被 GC。在 `UDPSocket.close` 后将解除对其的强引用，让 UDPSocket 实例遵从 GC。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.close.html) - -```tsx -() => void -``` - -### onClose - -监听关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onClose.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 关闭事件的回调函数 | - -### offClose - -取消监听关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offClose.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 关闭事件的回调函数 | - -### onError - -监听错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onError.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 错误事件的回调函数 | - -### offError - -取消监听错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offError.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 错误事件的回调函数 | - -### onListening - -监听开始监听数据包消息的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onListening.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听开始监听数据包消息的事件 | - -### offListening - -取消监听开始监听数据包消息的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offListening.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 监听开始监听数据包消息的事件 | - -### onMessage - -监听收到消息的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 收到消息的事件的回调函数 | - -### offMessage - -取消监听收到消息的事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offMessage.html) - -```tsx -(callback: Callback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 收到消息的事件的回调函数 | - -## 参数 - -### connect - -#### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 要发消息的地址 | -| port | `number` | 要发送消息的端口号 | - -### onClose - -#### Callback - -当一个 socket 完全关闭就发出该事件的回调函数 - -```tsx -(args: unknown[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `unknown[]` | - -### onError - -#### Callback - -错误事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -### onListening - -#### Callback - -监听开始监听数据包消息的事件 - -```tsx -(args: unknown[]) => void -``` - -| 参数 | 类型 | -| --- | --- | -| args | `unknown[]` | - -### onMessage - -#### Callback - -收到消息的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -#### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| message | `ArrayBuffer` | 收到的消息 | -| remoteInfo | `RemoteInfo` | 发送端地址信息 | -| localInfo | `LocalInfo` | 接收端地址信息 | - -#### RemoteInfo - -发送端地址信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 发送消息的 socket 的地址 | -| family | `string` | 使用的协议族，为 IPv4 或者 IPv6 | -| port | `number` | 端口号 | - -#### LocalInfo - -接收端地址信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 接收消息的 socket 的地址 | -| family | `string` | 使用的协议族，为 IPv4 或者 IPv6 | -| port | `number` | 端口号 | -| size | `number` | message 的大小，单位：字节 | - -### send - -#### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| address | `string` | | 是 | 要发消息的地址。在基础库 <= 2.9.3 版本必须是和本机同网段的 IP 地址，或安全域名列表内的域名地址；之后版本可以是任意 IP 和域名 | -| port | `number` | | 是 | 要发送消息的端口号 | -| message | string or ArrayBuffer | | 是 | 要发送的数据 | -| offset | `number` | `0` | 否 | 发送数据的偏移量，仅当 message 为 ArrayBuffer 类型时有效 | -| length | `number` | `message.byteLength` | 否 | 发送数据的长度，仅当 message 为 ArrayBuffer 类型时有效 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| UDPSocket | ✔️ | | | | -| UDPSocket.bind | ✔️ | | | | -| UDPSocket.setTTL | ✔️ | | | | -| UDPSocket.send | ✔️ | | | | -| UDPSocket.connect | ✔️ | | | | -| UDPSocket.write | ✔️ | | | | -| UDPSocket.close | ✔️ | | | | -| UDPSocket.onClose | ✔️ | | | | -| UDPSocket.offClose | ✔️ | | | | -| UDPSocket.onError | ✔️ | | | | -| UDPSocket.offError | ✔️ | | | | -| UDPSocket.onListening | ✔️ | | | | -| UDPSocket.offListening | ✔️ | | | | -| UDPSocket.onMessage | ✔️ | | | | -| UDPSocket.offMessage | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/network/udp/createUDPSocket.md b/versioned_docs/version-4.x/apis/network/udp/createUDPSocket.md deleted file mode 100644 index ca308a0afcf9..000000000000 --- a/versioned_docs/version-4.x/apis/network/udp/createUDPSocket.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.createUDPSocket() -sidebar_label: createUDPSocket ---- - -创建一个 UDP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/wx.createUDPSocket.html) - -## 类型 - -```tsx -() => UDPSocket -``` diff --git a/versioned_docs/version-4.x/apis/network/upload/UploadTask.md b/versioned_docs/version-4.x/apis/network/upload/UploadTask.md deleted file mode 100644 index 31578ab3a8a6..000000000000 --- a/versioned_docs/version-4.x/apis/network/upload/UploadTask.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: UploadTask -sidebar_label: UploadTask ---- - -一个可以监听上传进度变化事件，以及取消上传任务的对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.html) - -## 方法 - -### abort - -中断上传任务 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.abort.html) - -```tsx -() => void -``` - -### onProgressUpdate - -监听上传进度变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.onProgressUpdate.html) - -```tsx -(callback: OnProgressUpdateCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnProgressUpdateCallback` | 上传进度变化事件的回调函数 | - -### offProgressUpdate - -取消监听上传进度变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.offProgressUpdate.html) - -```tsx -(callback: OnProgressUpdateCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnProgressUpdateCallback` | 上传进度变化事件的回调函数 | - -### onHeadersReceived - -监听 HTTP Response Header 事件。会比请求完成事件更早 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.onHeadersReceived.html) - -```tsx -(callback: OnHeadersReceivedCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnHeadersReceivedCallback` | HTTP Response Header 事件的回调函数 | - -### offHeadersReceived - -取消监听 HTTP Response Header 事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.offHeadersReceived.html) - -```tsx -(callback: OnHeadersReceivedCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnHeadersReceivedCallback` | HTTP Response Header 事件的回调函数 | - -## 参数 - -### OnHeadersReceivedCallback - -HTTP Response Header 事件的回调函数 - -```tsx -(result: OnHeadersReceivedCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnHeadersReceivedCallbackResult` | - -### OnProgressUpdateCallback - -上传进度变化事件的回调函数 - -```tsx -(result: OnProgressUpdateCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnProgressUpdateCallbackResult` | - -### OnHeadersReceivedCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| header | `TaroGeneral.IAnyObject` | 开发者服务器返回的 HTTP Response Header | - -### OnProgressUpdateCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| progress | `number` | 上传进度百分比 | -| totalBytesExpectedToSend | `number` | 预期需要上传的数据总长度，单位 Bytes | -| totalBytesSent | `number` | 已经上传的数据长度，单位 Bytes | - -### UploadTaskPromise - -## 示例代码 - -```tsx -const uploadTask = Taro.uploadFile({ - url: 'http://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址 - filePath: tempFilePaths[0], - name: 'file', - formData:{ - 'user': 'test' - }, - success (res){ - const data = res.data - //do something - } -}) - -uploadTask.onProgressUpdate((res) => { - console.log('上传进度', res.progress) - console.log('已经上传的数据长度', res.totalBytesSent) - console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend) -}) - -uploadTask.abort() // 取消上传任务 -``` - -## API 支持度 - -| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| UploadTask | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| UploadTask.abort | ✔️ | | | ✔️ | ✔️ | | | -| UploadTask.onProgressUpdate | ✔️ | | | ✔️ | ✔️ | | | -| UploadTask.offProgressUpdate | ✔️ | | | ✔️ | ✔️ | | | -| UploadTask.onHeadersReceived | ✔️ | | | | ✔️ | | | -| UploadTask.offHeadersReceived | ✔️ | | | | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/network/upload/uploadFile.md b/versioned_docs/version-4.x/apis/network/upload/uploadFile.md deleted file mode 100644 index fc4e54b588e5..000000000000 --- a/versioned_docs/version-4.x/apis/network/upload/uploadFile.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Taro.uploadFile(option) -sidebar_label: uploadFile ---- - -将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/wx.uploadFile.html) - -## 类型 - -```tsx -(option: Option) => UploadTaskPromise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| url | `string` | | 是 | 开发者服务器地址 | -| filePath | `string` | | 是 | 要上传文件资源的路径 | -| name | `string` | | 是 | 文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容 | -| header | `TaroGeneral.IAnyObject` | | 否 | HTTP 请求 Header，Header 中不能设置 Referer | -| formData | `TaroGeneral.IAnyObject` | | 否 | HTTP 请求中其他额外的 form data | -| timeout | `number` | | 否 | 超时时间，单位为毫秒 | -| fileName | `string` | | 否 | 上传的文件名
API 支持度: h5 | -| withCredentials | `boolean` | `true` | 否 | 是否应使用传出凭据 (cookie) 发送此请求
API 支持度: h5 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `string` | 是 | 开发者服务器返回的数据 | -| statusCode | `number` | 是 | 开发者服务器返回的 HTTP 状态码 | -| errMsg | `string` | 是 | 调用结果 | -| header | `TaroGeneral.IAnyObject` | 否 | 开发者服务器返回的 HTTP Response Header
API 支持度: weapp
weapp: 非官方文档标注属性 | -| cookies | `string[]` | 否 | cookies
API 支持度: weapp
weapp: 非官方文档标注属性 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.chooseImage({ - success (res) { - const tempFilePaths = res.tempFilePaths - Taro.uploadFile({ - url: 'https://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址 - filePath: tempFilePaths[0], - name: 'file', - formData: { - 'user': 'test' - }, - success (res){ - const data = res.data - //do something - } - }) - } -}) -``` - -### 示例 2 - -```tsx -const uploadTask = Taro.uploadFile({ - url: 'https://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址 - filePath: tempFilePaths[0], - name: 'file', - formData:{ - 'user': 'test' - }, - success: function (res){ - var data = res.data - //do something - } -}) -uploadTask.progress((res) => { - console.log('上传进度', res.progress) - console.log('已经上传的数据长度', res.totalBytesSent) - console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend) -}) -uploadTask.abort() // 取消上传任务 -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/SocketTask.md b/versioned_docs/version-4.x/apis/network/websocket/SocketTask.md deleted file mode 100644 index ba2aca522c26..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/SocketTask.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: SocketTask -sidebar_label: SocketTask ---- - -WebSocket 任务，可通过 [Taro.connectSocket()](/docs/apis/network/websocket/SocketTask) 接口创建返回。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| socketTaskId | `number` | websocket 当前的连接 ID。 | -| readyState | `number` | websocket 当前的连接状态。 | -| errMsg | `string` | websocket 接口调用结果。 | -| CONNECTING | `number` | websocket 状态值：连接中。 | -| OPEN | `number` | websocket 状态值：已连接。 | -| CLOSING | `number` | websocket 状态值：关闭中。 | -| CLOSED | `number` | websocket 状态值：已关闭。 | -| ws | `WebSocket` | 浏览器 websocket 实例。（h5 端独有） | - -### send - -通过 WebSocket 连接发送数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.send.html) - -```tsx -(option: SendOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `SendOption` | - -### close - -关闭 WebSocket 连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.close.html) - -```tsx -(option: CloseOption) => void -``` - -| 参数 | 类型 | -| --- | --- | -| option | `CloseOption` | - -### onOpen - -监听 WebSocket 连接打开事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onOpen.html) - -```tsx -(callback: OnOpenCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnOpenCallback` | WebSocket 连接打开事件的回调函数 | - -### onClose - -监听 WebSocket 连接关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onClose.html) - -```tsx -(callback: OnCloseCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnCloseCallback` | WebSocket 连接关闭事件的回调函数 | - -### onError - -监听 WebSocket 错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onError.html) - -```tsx -(callback: OnErrorCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnErrorCallback` | WebSocket 错误事件的回调函数 | - -### onMessage - -监听 WebSocket 接受到服务器的消息事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onMessage.html) - -```tsx -(callback: OnMessageCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `T` | WebSocket 接受到服务器的消息事件的回调函数 | - -## 参数 - -### CloseOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| code | `number` | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| reason | `string` | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### OnCloseCallback - -WebSocket 连接关闭事件的回调函数 - -```tsx -(result: OnCloseCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnCloseCallbackResult` | - -### OnCloseCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| code | `number` | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 | -| reason | `string` | 一个可读的字符串，表示连接被关闭的原因。 | - -### OnErrorCallback - -WebSocket 错误事件的回调函数 - -```tsx -(result: OnErrorCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnErrorCallbackResult` | - -### OnErrorCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -### OnMessageCallback - -WebSocket 接受到服务器的消息事件的回调函数 - -```tsx -(result: OnMessageCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnMessageCallbackResult` | - -### OnMessageCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `T` | 服务器返回的消息 | - -### OnOpenCallback - -WebSocket 连接打开事件的回调函数 - -```tsx -(result: OnOpenCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnOpenCallbackResult` | - -### OnOpenCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| header | `TaroGeneral.IAnyObject` | 连接成功的 HTTP 响应 Header | - -### SendOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | string or ArrayBuffer | 是 | 需要发送的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## API 支持度 - -| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| SocketTask | ✔️ | ✔️ | ✔️ | | ✔️ | ✔️ | | -| SocketTask.send | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| SocketTask.close | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| SocketTask.onOpen | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| SocketTask.onClose | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| SocketTask.onError | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | -| SocketTask.onMessage | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | diff --git a/versioned_docs/version-4.x/apis/network/websocket/closeSocket.md b/versioned_docs/version-4.x/apis/network/websocket/closeSocket.md deleted file mode 100644 index af19fc20b7b6..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/closeSocket.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.closeSocket(option) -sidebar_label: closeSocket ---- - -关闭 WebSocket 连接 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.closeSocket.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| code | `number` | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| reason | `string` | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.connectSocket({ - url: 'test.php' -}) -//注意这里有时序问题， -//如果 Taro.connectSocket 还没回调 Taro.onSocketOpen，而先调用 Taro.closeSocket，那么就做不到关闭 WebSocket 的目的。 -//必须在 WebSocket 打开期间调用 Taro.closeSocket 才能关闭。 -Taro.onSocketOpen(function() { - Taro.closeSocket() -}) -Taro.onSocketClose(function(res) { - console.log('WebSocket 已关闭！') -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/connectSocket.md b/versioned_docs/version-4.x/apis/network/websocket/connectSocket.md deleted file mode 100644 index 5920fa9b070c..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/connectSocket.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.connectSocket(option) -sidebar_label: connectSocket ---- - -创建一个 WebSocket 连接。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。 - -**并发数** -- 1.7.0 及以上版本，最多可以同时存在 5 个 WebSocket 连接。 -- 1.7.0 以下版本，一个小程序同时只能有一个 WebSocket 连接，如果当前已存在一个 WebSocket 连接，会自动关闭该连接，并重新创建一个 WebSocket 连接。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.connectSocket.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 开发者服务器 wss 接口地址 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| header | `TaroGeneral.IAnyObject` | 否 | HTTP Header，Header 中不能设置 Referer | -| protocols | `string[]` | 否 | 子协议数组 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| tcpNoDelay | `boolean` | 否 | 建立 TCP 连接的时候的 TCP_NODELAY 设置 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.connectSocket({ - url: 'wss://example.qq.com', - header:{ - 'content-type': 'application/json' - }, - protocols: ['protocol1'] -}) -``` - -### 示例 2 - -```tsx -Taro.connectSocket({ - url: 'ws://echo.websocket.org/echo', - success: function () { - console.log('connect success') - } -}).then(task => { - task.onOpen(function () { - console.log('onOpen') - task.send({ data: 'xxx' }) - }) - task.onMessage(function (msg) { - console.log('onMessage: ', msg) - task.close() - }) - task.onError(function () { - console.log('onError') - }) - task.onClose(function (e) { - console.log('onClose: ', e) - }) -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/onSocketClose.md b/versioned_docs/version-4.x/apis/network/websocket/onSocketClose.md deleted file mode 100644 index 08dc5f9fb570..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/onSocketClose.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.onSocketClose(callback) -sidebar_label: onSocketClose ---- - -监听 WebSocket 连接关闭事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketClose.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | WebSocket 连接关闭事件的回调函数 | - -### Callback - -WebSocket 连接关闭事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| code | `number` | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 | -| reason | `string` | 一个可读的字符串，表示连接被关闭的原因。 | - -## 示例代码 - -```tsx -Taro.connectSocket({ - url: 'test.php' -}) -//注意这里有时序问题， -//如果 Taro.connectSocket 还没回调 Taro.onSocketOpen，而先调用 Taro.closeSocket，那么就做不到关闭 WebSocket 的目的。 -//必须在 WebSocket 打开期间调用 Taro.closeSocket 才能关闭。 -Taro.onSocketOpen(function () { - Taro.closeSocket() -}) -Taro.onSocketClose(function (res) { - console.log('WebSocket 已关闭！') -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/onSocketError.md b/versioned_docs/version-4.x/apis/network/websocket/onSocketError.md deleted file mode 100644 index 23d71d1ce744..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/onSocketError.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Taro.onSocketError(callback) -sidebar_label: onSocketError ---- - -监听 WebSocket 错误事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketError.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | WebSocket 错误事件的回调函数 | - -### Callback - -WebSocket 错误事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | - -## 示例代码 - -```tsx -Taro.connectSocket({ - url: 'test.php' -}) -Taro.onSocketOpen(function (res){ - console.log('WebSocket连接已打开！') -}) -Taro.onSocketError(function (res){ - console.log('WebSocket连接打开失败，请检查！') -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/onSocketMessage.md b/versioned_docs/version-4.x/apis/network/websocket/onSocketMessage.md deleted file mode 100644 index e15df3d57deb..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/onSocketMessage.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.onSocketMessage(callback) -sidebar_label: onSocketMessage ---- - -监听 WebSocket 接受到服务器的消息事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketMessage.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `T` | WebSocket 接受到服务器的消息事件的回调函数 | - -### Callback - -WebSocket 接受到服务器的消息事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `T` | 服务器返回的消息 | - -## 示例代码 - -```tsx -Taro.connectSocket({ - url: 'test.php' -}) -Taro.onSocketMessage(function (res) { - console.log('收到服务器内容：' + res.data) -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/onSocketOpen.md b/versioned_docs/version-4.x/apis/network/websocket/onSocketOpen.md deleted file mode 100644 index 91669e2480ac..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/onSocketOpen.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.onSocketOpen(callback) -sidebar_label: onSocketOpen ---- - -监听 WebSocket 连接打开事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.onSocketOpen.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | WebSocket 连接打开事件的回调函数 | - -### Callback - -WebSocket 连接打开事件的回调函数 - -```tsx -(result: OpenCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OpenCallbackResult` | - -### OpenCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| header | `TaroGeneral.IAnyObject` | 连接成功的 HTTP 响应 Header | - -## 示例代码 - -```tsx -Taro.connectSocket({ - url: 'test.php' -}) -Taro.onSocketOpen(function (res) { - console.log('WebSocket连接已打开！') -}) -``` diff --git a/versioned_docs/version-4.x/apis/network/websocket/sendSocketMessage.md b/versioned_docs/version-4.x/apis/network/websocket/sendSocketMessage.md deleted file mode 100644 index 1a6119b3c09e..000000000000 --- a/versioned_docs/version-4.x/apis/network/websocket/sendSocketMessage.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.sendSocketMessage(option) -sidebar_label: sendSocketMessage ---- - -通过 WebSocket 连接发送数据。需要先 Taro.connectSocket，并在 Taro.onSocketOpen 回调之后才能发送。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.sendSocketMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | string or ArrayBuffer | 是 | 需要发送的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -let socketOpen = false -const socketMsgQueue = [] -Taro.connectSocket({ - url: 'test.php' -}) -Taro.onSocketOpen(function(res) { - socketOpen = true - for (let i = 0; i < socketMsgQueue.length; i++){ - sendSocketMessage(socketMsgQueue[i]) - } - socketMsgQueue = [] -}) -function sendSocketMessage(msg) { - if (socketOpen) { - Taro.sendSocketMessage({ - data:msg - }) - } else { - socketMsgQueue.push(msg) - } -} -``` diff --git a/versioned_docs/version-4.x/apis/open-api/account/getAccountInfoSync.md b/versioned_docs/version-4.x/apis/open-api/account/getAccountInfoSync.md deleted file mode 100644 index 7f503ddf673f..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/account/getAccountInfoSync.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Taro.getAccountInfoSync() -sidebar_label: getAccountInfoSync ---- - -获取当前帐号信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/account-info/wx.getAccountInfoSync.html) - -## 类型 - -```tsx -() => AccountInfo -``` - -## 参数 - -### AccountInfo - -帐号信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| miniProgram | `MiniProgram` | 小程序帐号信息 | -| plugin | `Plugin` | 插件帐号信息（仅在插件中调用时包含这一项） | - -### MiniProgram - -小程序帐号信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 小程序 appId | -| envVersion | "develop" or "trial" or "release" | 小程序版本
since: 2.10.0 | -| version | `string` | 线上小程序版本号
since: 2.10.2 | - -### Plugin - -插件帐号信息（仅在插件中调用时包含这一项） - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| appId | `string` | 插件 appId | -| version | `string` | 插件版本号 | - -## 示例代码 - -```tsx -const accountInfo = Taro.getAccountInfoSync(); - -console.log(accountInfo.miniProgram.appId) // 小程序 appId -console.log(accountInfo.plugin.appId) // 插件 appId -console.log(accountInfo.plugin.version) // 插件版本号， 'a.b.c' 这样的形式 -``` diff --git a/versioned_docs/version-4.x/apis/open-api/address/chooseAddress.md b/versioned_docs/version-4.x/apis/open-api/address/chooseAddress.md deleted file mode 100644 index 5921c3c3447a..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/address/chooseAddress.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Taro.chooseAddress(option) -sidebar_label: chooseAddress ---- - -获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/address/wx.chooseAddress.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: SuccessCallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| userName | `string` | 收货人姓名 | -| postalCode | `string` | 邮编 | -| provinceName | `string` | 国标收货地址第一级地址 | -| cityName | `string` | 国标收货地址第二级地址 | -| countyName | `string` | 国标收货地址第三级地址 | -| streetName | `string` | 国标收货地址第四级地址 | -| detailInfo | `string` | 详细收货地址信息 | -| detailInfoNew | `string` | 新选择器详细收货地址信息 | -| nationalCode | `string` | 收货地址国家码 | -| telNumber | `string` | 收货人手机号码 | - -## 示例代码 - -```tsx -Taro.chooseAddress({ - success: function (res) { - console.log(res.userName) - console.log(res.postalCode) - console.log(res.provinceName) - console.log(res.cityName) - console.log(res.countyName) - console.log(res.detailInfo) - console.log(res.nationalCode) - console.log(res.telNumber) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/authorize/authorize.md b/versioned_docs/version-4.x/apis/open-api/authorize/authorize.md deleted file mode 100644 index f613117b84d3..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/authorize/authorize.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.authorize(option) -sidebar_label: authorize ---- - -提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorize.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| scope | `string` | 是 | 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -// 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope -Taro.getSetting({ - success: function (res) { - if (!res.authSetting['scope.record']) { - Taro.authorize({ - scope: 'scope.record', - success: function () { - // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问 - Taro.startRecord() - } - }) - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/authorize/authorizeForMiniProgram.md b/versioned_docs/version-4.x/apis/open-api/authorize/authorizeForMiniProgram.md deleted file mode 100644 index b372ed6a2bba..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/authorize/authorizeForMiniProgram.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.authorizeForMiniProgram(option) -sidebar_label: authorizeForMiniProgram ---- - -**仅小程序插件中能调用该接口**，用法同 [Taro.authorize](../authorize)。目前仅支持三种 scope - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorizeForMiniProgram.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| scope | `string` | 是 | 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### Scope - -scope 合法值 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) - -## 示例代码 - -```tsx -// 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope -Taro.authorizeForMiniProgram({ - scope: 'scope.record', - success () { - // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问 - Taro.startRecord() - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/card/addCard.md b/versioned_docs/version-4.x/apis/open-api/card/addCard.md deleted file mode 100644 index 4174ac881d6f..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/card/addCard.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Taro.addCard(option) -sidebar_label: addCard ---- - -批量添加卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。 - -**cardExt 说明** -cardExt 是卡券的扩展参数，其值是一个 JSON 字符串。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/card/wx.addCard.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cardList | `RequestInfo[]` | 是 | 需要添加的卡券列表 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RequestInfo - -需要添加的卡券列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cardExt | `string` | 卡券的扩展参数。需将 CardExt 对象 JSON 序列化为**字符串**传入 | -| cardId | `string` | 卡券 ID | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cardList | `AddCardResponseInfo[]` | 卡券添加结果列表 | -| errMsg | `string` | 调用结果 | - -### AddCardResponseInfo - -卡券添加结果列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cardExt | `string` | 卡券的扩展参数，结构请参考下文 | -| cardId | `string` | 用户领取到卡券的 ID | -| code | `string` | 加密 code，为用户领取到卡券的code加密后的字符串，解密请参照：[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) | -| isSuccess | `boolean` | 是否成功 | - -## 示例代码 - -```tsx -Taro.addCard({ - cardList: [ - { - cardId: '', - cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}' - }, { - cardId: '', - cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}' - } - ], - success: function (res) { - console.log(res.cardList) // 卡券添加结果 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/card/card.md b/versioned_docs/version-4.x/apis/open-api/card/card.md deleted file mode 100644 index 554ffc13b45a..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/card/card.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: 卡券 -sidebar_label: 卡券 ---- - -## Taro.addCard(OBJECT) - -使用方式同 [`wx.addCard`](https://developers.weixin.qq.com/miniprogram/dev/api/wx.addCard.html)，支持 `Promise` 化使用。 - -**示例代码：** - -```jsx -import Taro from '@tarojs/taro' - -Taro.addCard(params).then(...) -``` - -## Taro.openCard(OBJECT) - -使用方式同 [`wx.openCard`](https://developers.weixin.qq.com/miniprogram/dev/api/wx.openCard.html)，支持 `Promise` 化使用。 - -**示例代码：** - -```jsx -import Taro from '@tarojs/taro' - -Taro.openCard(params).then(...) -``` - -> API 支持度 - -| API | 微信小程序 | H5 | React Native | -| :-: | :-: | :-: | :-: | -| Taro.addCard | ✔️ | | | -| Taro.openCard | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/open-api/card/openCard.md b/versioned_docs/version-4.x/apis/open-api/card/openCard.md deleted file mode 100644 index 07dfee2cb4b0..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/card/openCard.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Taro.openCard(option) -sidebar_label: openCard ---- - -查看微信卡包中的卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/card/wx.openCard.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cardList | `RequestInfo[]` | 是 | 需要打开的卡券列表 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RequestInfo - -需要打开的卡券列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cardId | `string` | 卡券 ID | -| code | `string` | 由 Taro.addCard 的返回对象中的加密 code 通过解密后得到，解密请参照：[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) | - -## 示例代码 - -```tsx -Taro.openCard({ - cardList: [{ - cardId: '', - code: '' - }, { - cardId: '', - code: '' - }], - success: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveInfo.md b/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveInfo.md deleted file mode 100644 index efb6f3ab4d23..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveInfo.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.getChannelsLiveInfo(option) -sidebar_label: getChannelsLiveInfo ---- - -获取视频号直播信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| feedId | `string` | 直播 feedId | -| nonceId | `string` | 直播 nonceId | -| description | `string` | 直播主题 | -| status | `number` | 直播状态，2直播中，3直播结束 | -| headUrl | `string` | 视频号头像 | -| nickname | `string` | 视频号昵称 | - -### Status - -| 参数 | 说明 | -| --- | --- | -| 2 | 直播中 | -| 3 | 直播结束 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveNoticeInfo.md b/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveNoticeInfo.md deleted file mode 100644 index f79d40aef610..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsLiveNoticeInfo.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.getChannelsLiveNoticeInfo(option) -sidebar_label: getChannelsLiveNoticeInfo ---- - -获取视频号直播预告信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| nonceId | `string` | 预告 nonceId | -| status | `number` | 预告状态：0可用 1取消 2已用 | -| startTime | `string` | 开始时间 | -| headUrl | `string` | 直播封面 | -| nickname | `string` | 视频号昵称 | -| reservable | `boolean` | 是否可预约 | - -### Status - -| 参数 | 说明 | -| --- | --- | -| 0 | 可用 | -| 1 | 取消 | -| 2 | 已用 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsShareKey.md b/versioned_docs/version-4.x/apis/open-api/channels/getChannelsShareKey.md deleted file mode 100644 index 91448afeeaae..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/getChannelsShareKey.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.getChannelsShareKey(option) -sidebar_label: getChannelsShareKey ---- - -获取视频号直播卡片/视频卡片的分享来源， -仅当卡片携带了分享信息、同时用户已授权该小程序获取视频号分享信息且启动场景值为 1177、1184、1195、1208 时可用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsShareKey.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sharerOpenId | `string` | 分享者 openid | -| promoter | `Promoter` | 推广员 | - -### Promoter - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| finderNickname | `string` | 推广员昵称 | -| promoterId | `string` | 推广员id | -| promoterOpenId | `string` | 推广员openid | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsActivity.md b/versioned_docs/version-4.x/apis/open-api/channels/openChannelsActivity.md deleted file mode 100644 index 8fe60ec659f8..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsActivity.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.openChannelsActivity(option) -sidebar_label: openChannelsActivity ---- - -打开视频号视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsActivity.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 | -| feedId | `string` | 是 | 视频 feedId | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsEvent.md b/versioned_docs/version-4.x/apis/open-api/channels/openChannelsEvent.md deleted file mode 100644 index ebf4b41f261d..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsEvent.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.openChannelsEvent(option) -sidebar_label: openChannelsEvent ---- - -打开视频号活动页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsEvent.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 | -| eventId | `string` | 是 | 活动 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsLive.md b/versioned_docs/version-4.x/apis/open-api/channels/openChannelsLive.md deleted file mode 100644 index b96a682665d2..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsLive.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Taro.openChannelsLive(option) -sidebar_label: openChannelsLive ---- - -打开视频号直播 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsLive.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 | -| feedId | `string` | 否 | 直播 feedId，通过 getChannelsLiveInfo 接口获取 | -| nonceId | `string` | 否 | 直播 nonceId，通过 getChannelsLiveInfo 接口获取 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsUserProfile.md b/versioned_docs/version-4.x/apis/open-api/channels/openChannelsUserProfile.md deleted file mode 100644 index ed1b30176d77..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/openChannelsUserProfile.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.openChannelsUserProfile(option) -sidebar_label: openChannelsUserProfile ---- - -打开视频号主页 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsUserProfile.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| finderUserName | `string` | 是 | 视频号 id | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/channels/reserveChannelsLive.md b/versioned_docs/version-4.x/apis/open-api/channels/reserveChannelsLive.md deleted file mode 100644 index 16366fb0234e..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/channels/reserveChannelsLive.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Taro.reserveChannelsLive(option) -sidebar_label: reserveChannelsLive ---- - -预约视频号直播 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.reserveChannelsLive.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| noticeId | `string` | 预告 id，通过 [getChannelsLiveNoticeInfo](./getChannelsLiveNoticeInfo) 接口获取 | diff --git a/versioned_docs/version-4.x/apis/open-api/customer-service/openCustomerServiceChat.md b/versioned_docs/version-4.x/apis/open-api/customer-service/openCustomerServiceChat.md deleted file mode 100644 index b801e140f96f..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/customer-service/openCustomerServiceChat.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Taro.openCustomerServiceChat(option) -sidebar_label: openCustomerServiceChat ---- - -打开微信客服。了解更多信息，可以参考微信客服介绍：https://work.weixin.qq.com/kf/。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/service-chat/wx.openCustomerServiceChat.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### ExtInfo - -| 参数 | 类型 | -| --- | --- | -| url | `string` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| extInfo | `ExtInfo` | 是 | 客服信息 | -| corpId | `string` | 是 | 企业ID | -| showMessageCard | `boolean` | 否 | 是否发送小程序气泡消息，默认值：false | -| sendMessageTitle | `string` | 否 | 气泡消息标题 | -| sendMessagePath | `string` | 否 | 气泡消息小程序路径 | -| sendMessageImg | `string` | 否 | 气泡消息图片 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.openCustomerServiceChat({ - extInfo: {url: ''}, - corpId: '', - success: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/device-voip/getDeviceVoIPList.md b/versioned_docs/version-4.x/apis/open-api/device-voip/getDeviceVoIPList.md deleted file mode 100644 index 7850d6974185..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/device-voip/getDeviceVoIPList.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.getDeviceVoIPList(option) -sidebar_label: getDeviceVoIPList ---- - -查询当前用户授权的音视频通话设备（组）信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.getDeviceVoIPList.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | -| --- | --- | -| list | `DeviceVoIP[]` | - -### DeviceVoIP - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sn | `string` | 设备唯一序列号。（仅单台设备时） | -| model_id | `string` | 设备型号 id。通过微信公众平台注册设备获得。（仅单台设备时） | -| group_id | `string` | 设备组的唯一标识 id（仅设备组时） | -| status | `number` | 设备（组）授权状态。0：未授权；1：已授权 | diff --git a/versioned_docs/version-4.x/apis/open-api/device-voip/requestDeviceVoIP.md b/versioned_docs/version-4.x/apis/open-api/device-voip/requestDeviceVoIP.md deleted file mode 100644 index fd291494f904..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/device-voip/requestDeviceVoIP.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.requestDeviceVoIP(option) -sidebar_label: requestDeviceVoIP ---- - -请求用户授权与设备（组）间进行音视频通话 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.requestDeviceVoIP.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| sn | `string` | 是 | 设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-） | -| snTicket | `string` | 是 | 设备票据，5分钟内有效 | -| modelId | `string` | 是 | 设备型号 id。通过微信公众平台注册设备获得。 | -| deviceName | `string` | 是 | 设备名称，将显示在授权弹窗内（长度不超过13）。授权框中「设备名字」= 「deviceName」 + 「modelId 对应设备型号」 | -| isGroup | `boolean` | 否 | 是否为授权设备组，默认 false | -| groupId | `string` | 是 | 设备组的唯一标识 id 。isGroup 为 true 时只需要传该参数，isGroup 为 false 时不需要传该参数，但需要传 sn、snTicket、modelId、deviceName 。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/facial/checkIsSupportFacialRecognition.md b/versioned_docs/version-4.x/apis/open-api/facial/checkIsSupportFacialRecognition.md deleted file mode 100644 index 4c5f4c95bb48..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/facial/checkIsSupportFacialRecognition.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.checkIsSupportFacialRecognition(option) -sidebar_label: checkIsSupportFacialRecognition ---- - -检查是否支持面部识别 - -支持情况： - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| checkAliveType | `number` | 否 | 交互方式 | -| complete | `(res: CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `number` | 错误码 | diff --git a/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerify.md b/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerify.md deleted file mode 100644 index 53c557530ba8..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerify.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.startFacialRecognitionVerify(option) -sidebar_label: startFacialRecognitionVerify ---- - -开始人脸识别认证 - -支持情况： - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| name | `string` | 是 | 身份证名称 | -| idCardNumber | `string` | 是 | 身份证名称 | -| checkAliveType | `number` | 否 | 交互方式 | -| complete | `(res: CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `number` | 错误码 | -| verifyResult | `string` | 认证结果 | diff --git a/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerifyAndUploadVideo.md b/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerifyAndUploadVideo.md deleted file mode 100644 index 3e737853e8e3..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/facial/startFacialRecognitionVerifyAndUploadVideo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.startFacialRecognitionVerifyAndUploadVideo(option) -sidebar_label: startFacialRecognitionVerifyAndUploadVideo ---- - -开始人脸识别认证并上传认证视频 - -支持情况： - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| name | `string` | 是 | 身份证名称 | -| idCardNumber | `string` | 是 | 身份证名称 | -| checkAliveType | `number` | 否 | 交互方式 | -| complete | `(res: CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| errCode | `number` | 错误码 | -| verifyResult | `string` | 认证结果 | diff --git a/versioned_docs/version-4.x/apis/open-api/favorites/addFileToFavorites.md b/versioned_docs/version-4.x/apis/open-api/favorites/addFileToFavorites.md deleted file mode 100644 index 1ceb4e942559..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/favorites/addFileToFavorites.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Taro.addFileToFavorites(option) -sidebar_label: addFileToFavorites ---- - -收藏文件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/favorites/wx.addFileToFavorites.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要收藏的文件地址，必须为本地路径或临时路径 | -| fileName | `string` | 否 | 自定义文件名，若留空则使用filePath中的文件名 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -### 示例 1 - -```tsx -// callback 写法 -Taro.downloadFile({ - url: URL, // 下载url - success (res) { - // 下载完成后收藏 - Taro.addFileToFavorites({ - filePath: res.tempFilePath, - success() {}, - fail: console.error, - }) - }, - fail: console.error, -}) -``` - -### 示例 2 - -```tsx -// async await 写法 -const { tempFilePath } = await Taro.downloadFile({ - url: URL, // 下载url -}) -// 下载完成后收藏 -await Taro.addFileToFavorites({ - filePath: res.tempFilePath, -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/favorites/addVideoToFavorites.md b/versioned_docs/version-4.x/apis/open-api/favorites/addVideoToFavorites.md deleted file mode 100644 index 97009c3a7db7..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/favorites/addVideoToFavorites.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Taro.addVideoToFavorites(option) -sidebar_label: addVideoToFavorites ---- - -收藏视频 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/favorites/wx.addVideoToFavorites.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| videoPath | `string` | 是 | 要收藏的视频地址，必须为本地路径或临时路径 | -| thumbPath | `string` | 否 | 缩略图路径，若留空则使用视频首帧 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -### 示例 1 - -```tsx -// callback 写法 -Taro.downloadFile({ - url: URL, // 下载url - success (res) { - // 下载完成后收藏 - Taro.addVideoToFavorites({ - videoPath: res.tempFilePath, - success() {}, - fail: console.error, - }) - }, - fail: console.error, -}) -``` - -### 示例 2 - -```tsx -// async await 写法 -const { tempFilePath } = await Taro.downloadFile({ - url: URL, // 下载url -}) -// 下载完成后收藏 -await Taro.addVideoToFavorites({ - videoPath: res.tempFilePath, -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/group/getGroupEnterInfo.md b/versioned_docs/version-4.x/apis/open-api/group/getGroupEnterInfo.md deleted file mode 100644 index 8fd1745295b6..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/group/getGroupEnterInfo.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Taro.getGroupEnterInfo(option) -sidebar_label: getGroupEnterInfo ---- - -获取微信群聊场景下的小程序启动信息。群聊场景包括群聊小程序消息卡片、群待办、群工具。可用于获取当前群的 opengid。 - -**Tips** -- 如需要展示群名称，小程序可以使用[开放数据组件](/docs/components/open/open-data) -- 小游戏可以通过 `Taro.getGroupInfo` 接口获取群名称 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/group/wx.getGroupEnterInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| errMsg | `string` | 是 | 错误信息 | -| encryptedData | `string` | 是 | 包括敏感数据在内的完整转发信息的加密数据，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| iv | `string` | 是 | 加密算法的初始向量，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| cloudID | `string` | 否 | 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | - -## 示例代码 - -```tsx -Taro.getGroupEnterInfo({ - success(res) { - // res - { - errMsg: 'getGroupEnterInfo:ok', - encryptedData: '', - iv: '' - } - }, - fail() { } -}) -``` - -敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。 获取得到的开放数据为以下 json 结构（其中 opengid 为当前群的唯一标识）： - -```json -{ - "opengid": "OPENGID" -} -``` diff --git a/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoice.md b/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoice.md deleted file mode 100644 index ca59505ce47e..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoice.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.chooseInvoice(option) -sidebar_label: chooseInvoice ---- - -选择用户已有的发票。 - -**通过 cardId 和 encryptCode 获得报销发票的信息** -请参考[微信电子发票文档](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21517918939oae3U)中，「查询报销发票信息」部分。 -其中 `access_token` 的获取请参考[auth.getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)文档 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoice.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| invoiceInfo | `string` | 用户选中的发票信息，格式为一个 JSON 字符串，包含三个字段： card_id：所选发票卡券的 cardId，encrypt_code：所选发票卡券的加密 code，报销方可以通过 cardId 和 encryptCode 获得报销发票的信息，app_id： 发票方的 appId。 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.chooseInvoice({ - success: function (res) {} -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoiceTitle.md b/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoiceTitle.md deleted file mode 100644 index 3041f8cda8d1..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/invoice/chooseInvoiceTitle.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Taro.chooseInvoiceTitle(option) -sidebar_label: chooseInvoiceTitle ---- - -选择用户的发票抬头。当前小程序必须关联一个公众号，且这个公众号是完成了[微信认证](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1496554031_RD4xe)的，才能调用 chooseInvoiceTitle。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/invoice/wx.chooseInvoiceTitle.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bankAccount | `string` | 银行账号 | -| bankName | `string` | 银行名称 | -| companyAddress | `string` | 单位地址 | -| errMsg | `string` | 错误信息 | -| taxNumber | `string` | 抬头税号 | -| telephone | `string` | 手机号码 | -| title | `string` | 抬头名称 | -| type | `keyof InvoiceType` | 抬头类型 | - -### InvoiceType - -抬头类型 - -| 参数 | 类型 | -| --- | --- | -| 0 | `"单位"` | -| 1 | `"个人"` | - -## 示例代码 - -```tsx -Taro.chooseInvoiceTitle({ - success: function(res) {} -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/license-plate/chooseLicensePlate.md b/versioned_docs/version-4.x/apis/open-api/license-plate/chooseLicensePlate.md deleted file mode 100644 index 03f70a4a3fe8..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/license-plate/chooseLicensePlate.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.chooseLicensePlate(option) -sidebar_label: chooseLicensePlate ---- - -选择车牌号 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/license-plate/wx.chooseLicensePlate.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| plateNumber | `string` | 用户选择的车牌号 | diff --git a/versioned_docs/version-4.x/apis/open-api/login/checkSession.md b/versioned_docs/version-4.x/apis/open-api/login/checkSession.md deleted file mode 100644 index cbb833cc79f2..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/login/checkSession.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Taro.checkSession(option) -sidebar_label: checkSession ---- - -检查登录态是否过期。 - -通过 Taro.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序，用户登录态越有可能失效。反之如果用户一直在使用小程序，则用户登录态一直保持有效。具体时效逻辑由微信维护，对开发者透明。开发者只需要调用 Taro.checkSession 接口检测当前用户登录态是否有效。 - -登录态过期后开发者可以再调用 Taro.login 获取新的用户登录态。调用 Taro.checkSession 成功说明当前 session_key 未过期，调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.checkSession.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.checkSession({ - success: function () { - //session_key 未过期，并且在本生命周期一直有效 - }, - fail: function () { - // session_key 已经失效，需要重新执行登录流程 - Taro.login() //重新登录 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/login/login.md b/versioned_docs/version-4.x/apis/open-api/login/login.md deleted file mode 100644 index 4c909a9e1de0..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/login/login.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.login(option) -sidebar_label: login ---- - -调用接口获取登录凭证（code）。通过凭证进而换取用户登录态信息，包括用户的唯一标识（openid）及本次登录的会话密钥（session_key）等。用户数据的加解密通讯需要依赖会话密钥完成。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| timeout | `number` | 否 | 超时时间，单位ms | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| code | `string` | 用户登录凭证（有效期五分钟）。开发者需要在开发者服务器后台调用 [auth.code2Session](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html)，使用 code 换取 openid 和 session_key 等信息 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.login({ - success: function (res) { - if (res.code) { - //发起网络请求 - Taro.request({ - url: 'https://test.com/onLogin', - data: { - code: res.code - } - }) - } else { - console.log('登录失败！' + res.errMsg) - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/login/pluginLogin.md b/versioned_docs/version-4.x/apis/open-api/login/pluginLogin.md deleted file mode 100644 index 6dbd3dec8fad..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/login/pluginLogin.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.pluginLogin(option) -sidebar_label: pluginLogin ---- - -**该接口仅在小程序插件中可调用**，调用接口获得插件用户标志凭证（code）。插件可以此凭证换取用于识别用户的标识 openpid。用户不同、宿主小程序不同或插件不同的情况下，该标识均不相同，即当且仅当同一个用户在同一个宿主小程序中使用同一个插件时，openpid 才会相同 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.pluginLogin.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| code | `string` | 用于换取 openpid 的凭证（有效期五分钟）。插件开发者可以用此 code 在开发者服务器后台调用 [auth.getPluginOpenPId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.getPluginOpenPId.html) 换取 openpid。 | diff --git a/versioned_docs/version-4.x/apis/open-api/my-miniprogram/checkIsAddedToMyMiniProgram.md b/versioned_docs/version-4.x/apis/open-api/my-miniprogram/checkIsAddedToMyMiniProgram.md deleted file mode 100644 index 23fd5b805475..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/my-miniprogram/checkIsAddedToMyMiniProgram.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.checkIsAddedToMyMiniProgram(option) -sidebar_label: checkIsAddedToMyMiniProgram ---- - -检查小程序是否被添加至 「我的小程序」 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/my-miniprogram/wx.checkIsAddedToMyMiniProgram.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| added | `boolean` | 是否被添加至 「我的小程序」 | diff --git a/versioned_docs/version-4.x/apis/open-api/privacy/getPrivacySetting.md b/versioned_docs/version-4.x/apis/open-api/privacy/getPrivacySetting.md deleted file mode 100644 index bb3c8dad2056..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/privacy/getPrivacySetting.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.getPrivacySetting(option) -sidebar_label: getPrivacySetting ---- - -查询隐私授权情况。隐私合规开发指南详情可见《小程序隐私协议开发指南》 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.getPrivacySetting.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| needAuthorization | `boolean` | 是否需要用户授权隐私协议（如果开发者没有在[mp后台-设置-服务内容声明-用户隐私保护指引]中声明隐私收集类型则会返回false；如果开发者声明了隐私收集，且用户之前同意过隐私协议则会返回false；如果开发者声明了隐私收集，且用户还没同意过则返回true；如果用户之前同意过、但后来小程序又新增了隐私收集类型也会返回true） | -| privacyContractName | `string` | 隐私授权协议的名称 | diff --git a/versioned_docs/version-4.x/apis/open-api/privacy/onNeedPrivacyAuthorization.md b/versioned_docs/version-4.x/apis/open-api/privacy/onNeedPrivacyAuthorization.md deleted file mode 100644 index 9ea75301c5c5..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/privacy/onNeedPrivacyAuthorization.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Taro.onNeedPrivacyAuthorization(listener) -sidebar_label: onNeedPrivacyAuthorization ---- - -监听隐私接口需要用户授权事件。当需要用户进行隐私授权时会触发。触发该事件时，开发者需要弹出隐私协议说明，并在用户同意或拒绝授权后调用回调接口 resolve 触发原隐私接口或组件继续执行。隐私合规开发指南详情可见《小程序隐私协议开发指南》 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.onNeedPrivacyAuthorization.html) - -## 类型 - -```tsx -(listener: Listener) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| listener | `Listener` | - -### ResolveOption - -resolve 是 onNeedPrivacyAuthorization 的回调参数，是一个接口函数。 -当触发 needPrivacyAuthorization 事件时，触发该事件的隐私接口或组件会处于 pending 状态。 -如果调用 resolve({ buttonId: 'disagree-btn'， event:'agree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会继续执行。其中 buttonId 为隐私同意授权按钮的id，为确保用户有同意的操作，基础库会检查对应的同意按钮是否被点击过。 -如果调用 resolve({ event: 'disagree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会失败并返回 API:fail privacy permission is not authorized 的错误信息。 -在调用 resolve({ event: 'agree'/'disagree' }) 之前，开发者可以调用 resolve({ event: 'exposureAuthorization' }) 把隐私弹窗曝光告知平台。 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| event | "exposureAuthorization" or "agree" or "disagree" | 是 | 用户操作类型 | -| buttonId | `string` | 否 | 同意授权按钮的id （仅event=agree时必填） | - -### EventInfo - -触发本次 onNeedPrivacyAuthorization 事件的关联信息 - -| 参数 | 类型 | -| --- | --- | -| referrer | `string` | - -### Listener - -隐私授权监听函数 - -```tsx -(resolve: (option: ResolveOption) => void,eventInfo: EventInfo) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| resolve | `(option: ResolveOption) => void` | 事件回调函数 | -| eventInfo | `EventInfo` | 关联事件信息 | diff --git a/versioned_docs/version-4.x/apis/open-api/privacy/openPrivacyContract.md b/versioned_docs/version-4.x/apis/open-api/privacy/openPrivacyContract.md deleted file mode 100644 index 1d49ade79b35..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/privacy/openPrivacyContract.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.openPrivacyContract(option) -sidebar_label: openPrivacyContract ---- - -跳转至隐私协议页面。隐私合规开发指南详情可见《小程序隐私协议开发指南》 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.openPrivacyContract.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/privacy/requirePrivacyAuthorize.md b/versioned_docs/version-4.x/apis/open-api/privacy/requirePrivacyAuthorize.md deleted file mode 100644 index cc8d4edf8709..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/privacy/requirePrivacyAuthorize.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.requirePrivacyAuthorize(option) -sidebar_label: requirePrivacyAuthorize ---- - -模拟隐私接口调用，并触发隐私弹窗逻辑。隐私合规开发指南详情可见《小程序隐私协议开发指南》 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.requirePrivacyAuthorize.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/redpackage/showRedPackage.md b/versioned_docs/version-4.x/apis/open-api/redpackage/showRedPackage.md deleted file mode 100644 index e0aaa52327c1..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/redpackage/showRedPackage.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.showRedPackage(option) -sidebar_label: showRedPackage ---- - -拉取h5领取红包封面页。获取参考红包封面地址参考 [微信红包封面开发平台](https://cover.weixin.qq.com/cgi-bin/mmcover-bin/readtemplate?t=page/index#/doc?page=introduce)。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/redpackage/wx.showRedPackage.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 封面地址 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/open-api/settings/AuthSetting.md b/versioned_docs/version-4.x/apis/open-api/settings/AuthSetting.md deleted file mode 100644 index 294281837a71..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/settings/AuthSetting.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: AuthSetting -sidebar_label: AuthSetting ---- - -用户授权设置信息，详情参考[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) - -## 方法 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| scope.userInfo | `boolean` | 否 | 是否授权用户信息，对应接口 [Taro.getUserInfo](/docs/apis/open-api/user-info/getUserInfo) | -| scope.userLocation | `boolean` | 否 | 是否授权地理位置，对应接口 [Taro.getLocation](/docs/apis/location/getLocation), [Taro.chooseLocation](/docs/apis/location/chooseLocation) | -| scope.address | `boolean` | 否 | 是否授权通讯地址，对应接口 [Taro.chooseAddress](/docs/apis/open-api/address/chooseAddress) | -| scope.invoiceTitle | `boolean` | 否 | 是否授权发票抬头，对应接口 [Taro.chooseInvoiceTitle](/docs/apis/open-api/invoice/chooseInvoiceTitle) | -| scope.invoice | `boolean` | 否 | 是否授权获取发票，对应接口 [Taro.chooseInvoice](/docs/apis/open-api/invoice/chooseInvoice) | -| scope.werun | `boolean` | 否 | 是否授权微信运动步数，对应接口 [Taro.getWeRunData](/docs/apis/open-api/werun/getWeRunData) | -| scope.record | `boolean` | 否 | 是否授权录音功能，对应接口 [Taro.startRecord](/docs/apis/media/recorder/startRecord) | -| scope.writePhotosAlbum | `boolean` | 否 | 是否授权保存到相册 [Taro.saveImageToPhotosAlbum](/docs/apis/media/image/saveImageToPhotosAlbum), [Taro.saveVideoToPhotosAlbum](/docs/apis/media/video/saveVideoToPhotosAlbum) | -| scope.camera | `boolean` | 否 | 是否授权摄像头，对应 [camera](/docs/components/media/camera) 组件 | -| scope.bluetoothBackground | `boolean` | 否 | 是否授权小程序在后台运行蓝牙，对应接口 [Taro.openBluetoothAdapterBackground](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/setting/(wx.openBluetoothAdapterBackground).html) | diff --git a/versioned_docs/version-4.x/apis/open-api/settings/SubscriptionsSetting.md b/versioned_docs/version-4.x/apis/open-api/settings/SubscriptionsSetting.md deleted file mode 100644 index eacd6cd3d543..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/settings/SubscriptionsSetting.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: SubscriptionsSetting -sidebar_label: SubscriptionsSetting ---- - -订阅消息设置 - -注意事项 -- itemSettings 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/setting/SubscriptionsSetting.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mainSwitch | `boolean` | 订阅消息总开关，true 为开启，false 为关闭 | -| itemSettings | `{ [TEMPLATE_ID: string]: string; }` | 每一项订阅消息的订阅状态。itemSettings对象的键为一次性订阅消息的模板id或系统订阅消息的类型
- 一次性订阅消息使用方法详见 [Taro.requestSubscribeMessage](/docs/apis/open-api/subscribe-message/requestSubscribeMessage)
- 永久订阅消息（仅小游戏可用）使用方法详见 [Taro.requestSubscribeSystemMessage](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeSystemMessage.html) | - -## 参数 - -### TemplateReflex - -模版消息订阅类型 - -| 参数 | 说明 | -| --- | --- | -| accept | 表示用户同意订阅该条id对应的模板消息 | -| reject | 表示用户拒绝订阅该条id对应的模板消息 | -| ban | 表示已被后台封禁 | - -## 示例代码 - -```tsx -Taro.getSetting({ - withSubscriptions: true, - success (res) { - console.log(res.authSetting) - // res.authSetting = { - // "scope.userInfo": true, - // "scope.userLocation": true - // } - console.log(res.subscriptionsSetting) - // res.subscriptionsSetting = { - // mainSwitch: true, // 订阅消息总开关 - // itemSettings: { // 每一项开关 - // SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息 - // SYS_MSG_TYPE_RANK: 'accept' - // zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息 - // ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban', - // } - // } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/settings/getSetting.md b/versioned_docs/version-4.x/apis/open-api/settings/getSetting.md deleted file mode 100644 index 2d859ca56fbc..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/settings/getSetting.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Taro.getSetting(option) -sidebar_label: getSetting ---- - -获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/setting/wx.getSetting.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| withSubscriptions | `boolean` | 否 | 是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| authSetting | `AuthSetting` | 用户授权结果 | -| subscriptionsSetting | `SubscriptionsSetting` | 用户订阅消息设置，接口参数 withSubscriptions 值为 true 时才会返回。 | -| miniprogramAuthSetting | `AuthSetting` | 在插件中调用时，当前宿主小程序的用户授权结果 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.getSetting({ - success: function (res) { - console.log(res.authSetting) - // res.authSetting = { - // "scope.userInfo": true, - // "scope.userLocation": true - // } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/settings/openSetting.md b/versioned_docs/version-4.x/apis/open-api/settings/openSetting.md deleted file mode 100644 index 3e75818fd15c..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/settings/openSetting.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Taro.openSetting(option) -sidebar_label: openSetting ---- - -调起客户端小程序设置界面，返回用户设置的操作结果。**设置界面只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。 - -注意：[2.3.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始，用户发生点击行为后，才可以跳转打开设置页，管理授权信息。[详情](https://developers.weixin.qq.com/community/develop/doc/000cea2305cc5047af5733de751008) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/setting/wx.openSetting.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| withSubscriptions | `boolean` | 否 | 是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| authSetting | `AuthSetting` | 用户授权结果 | -| subscriptionsSetting | `SubscriptionsSetting` | 用户订阅消息设置，接口参数 withSubscriptions 值为 true 时才会返回。 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.openSetting({ - success: function (res) { - console.log(res.authSetting) - // res.authSetting = { - // "scope.userInfo": true, - // "scope.userLocation": true - // } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/soter/checkIsSoterEnrolledInDevice.md b/versioned_docs/version-4.x/apis/open-api/soter/checkIsSoterEnrolledInDevice.md deleted file mode 100644 index bc7300fc45a0..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/soter/checkIsSoterEnrolledInDevice.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.checkIsSoterEnrolledInDevice(option) -sidebar_label: checkIsSoterEnrolledInDevice ---- - -获取设备内是否录入如指纹等生物信息的接口 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/soter/wx.checkIsSoterEnrolledInDevice.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| checkAuthMode | `keyof RequestAuthModes` | 是 | 认证方式 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### RequestAuthModes - -| 参数 | 说明 | -| --- | --- | -| fingerPrint | 指纹识别 | -| facial | 人脸识别 | -| speech | 声纹识别
API 支持度: 暂未支持 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errMsg | `string` | 错误信息 | -| isEnrolled | `boolean` | 是否已录入信息 | - -## 示例代码 - -```tsx -Taro.checkIsSoterEnrolledInDevice({ - checkAuthMode: 'fingerPrint', - success: function (res) { - console.log(res.isEnrolled) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/soter/checkIsSupportSoterAuthentication.md b/versioned_docs/version-4.x/apis/open-api/soter/checkIsSupportSoterAuthentication.md deleted file mode 100644 index af8c1d5e2e70..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/soter/checkIsSupportSoterAuthentication.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.checkIsSupportSoterAuthentication(option) -sidebar_label: checkIsSupportSoterAuthentication ---- - -获取本机支持的 SOTER 生物认证方式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/soter/wx.checkIsSupportSoterAuthentication.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| supportMode | `(keyof requestAuthModes)[]` | 该设备支持的可被SOTER识别的生物识别方式 | -| errMsg | `string` | 调用信息 | - -### requestAuthModes - -| 参数 | 说明 | -| --- | --- | -| fingerPrint | 指纹识别 | -| facial | 人脸识别 | -| speech | 声纹识别
API 支持度: 暂未支持 | - -## 示例代码 - -```tsx -Taro.checkIsSupportSoterAuthentication({ - success: function (res) { - // res.supportMode = [] 不具备任何被SOTER支持的生物识别方式 - // res.supportMode = ['fingerPrint'] 只支持指纹识别 - // res.supportMode = ['fingerPrint', 'facial'] 支持指纹识别和人脸识别 - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/soter/startSoterAuthentication.md b/versioned_docs/version-4.x/apis/open-api/soter/startSoterAuthentication.md deleted file mode 100644 index 5e19263b4b86..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/soter/startSoterAuthentication.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Taro.startSoterAuthentication(option) -sidebar_label: startSoterAuthentication ---- - -开始 SOTER 生物认证。验证流程请参考[说明](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/bio-auth.html)。 - -**resultJSON 说明** -此数据为设备TEE中，将传入的challenge和TEE内其他安全信息组成的数据进行组装而来的JSON，对下述字段的解释如下表。例子如下： -| 字段名 | 说明 | -|---|----| -| raw | 调用者传入的challenge | -| fid | （仅Android支持）本次生物识别认证的生物信息编号（如指纹识别则是指纹信息在本设备内部编号） | -| counter | 防重放特征参数 | -| tee_n | TEE名称（如高通或者trustonic等） | -| tee_v | TEE版本号 | -| fp_n | 指纹以及相关逻辑模块提供商（如FPC等） | -| fp_v | 指纹以及相关模块版本号 | -| cpu_id | 机器唯一识别ID | -| uid | 概念同Android系统定义uid，即应用程序编号 | - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/soter/wx.startSoterAuthentication.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| challenge | `string` | 是 | 挑战因子。挑战因子为调用者为此次生物鉴权准备的用于签名的字符串关键识别信息，将作为 `resultJSON` 的一部分，供调用者识别本次请求。例如：如果场景为请求用户对某订单进行授权确认，则可以将订单号填入此参数。 | -| requestAuthModes | `(keyof requestAuthModes)[]` | 是 | 请求使用的可接受的生物认证方式 | -| authContent | `string` | 否 | 验证描述，即识别过程中显示在界面上的对话框提示内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| authMode | `string` | 生物认证方式 | -| errCode | `number` | 错误码 | -| errMsg | `string` | 错误信息 | -| resultJSON | `string` | 在设备安全区域（TEE）内获得的本机安全信息（如TEE名称版本号等以及防重放参数）以及本次认证信息（仅Android支持，本次认证的指纹ID）。具体说明见下文 | -| resultJSONSignature | `string` | 用SOTER安全密钥对 `resultJSON` 的签名(SHA256 with RSA/PSS, saltlen=20) | - -### requestAuthModes - -| 参数 | 说明 | -| --- | --- | -| fingerPrint | 指纹识别 | -| facial | 人脸识别 | -| speech | 声纹识别
API 支持度: 暂未支持 | - -## 示例代码 - -```tsx -Taro.startSoterAuthentication({ - requestAuthModes: ['fingerPrint'], - challenge: '123456', - authContent: '请用指纹解锁', - success: function (res) { } -}) -``` - -```json -{ - "raw":"msg", - "fid":"2", - "counter":123, - "tee_n":"TEE Name", - "tee_v":"TEE Version", - "fp_n":"Fingerprint Sensor Name", - "fp_v":"Fingerprint Sensor Version", - "cpu_id":"CPU Id", - "uid":"21" -} -``` diff --git a/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeDeviceMessage.md b/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeDeviceMessage.md deleted file mode 100644 index cd78b24cde78..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeDeviceMessage.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Taro.requestSubscribeDeviceMessage(option) -sidebar_label: requestSubscribeDeviceMessage ---- - -订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息。当用户点击“允许”按钮时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeDeviceMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tmplIds | `string[]` | 是 | 需要订阅的消息模板的 id 的集合，一次调用最多可订阅3条消息 | -| sn | `string` | 是 | 设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-）。 | -| snTicket | `string` | 是 | 设备票据，5分钟内有效。 | -| modelId | `string` | 是 | 设备型号 id 。通过微信公众平台注册设备获得。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | `number` | 接口调用失败错误码，有可能为空 | -| errMsg | `string` | 接口调用失败错误信息 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| [TEMPLATE_ID] | "accept" or "reject" or "ban" or "filter" or "acceptWithAudio" | [TEMPLATE_ID]是动态的键，即模板id | -| errMsg | `string` | 接口调用成功时errMsg值为'requestSubscribeMessage:ok' | - -#### 示例代码 - -表示用户同意订阅 zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE 这条消息 -```json -{ - "errMsg": "requestSubscribeDeviceMessage:ok", - "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept" -} -``` - -### TemplateReflex - -模版消息订阅类型 - -| 参数 | 说明 | -| --- | --- | -| accept | 表示用户同意订阅该条id对应的模板消息 | -| reject | 表示用户拒绝订阅该条id对应的模板消息 | -| ban | 表示已被后台封禁 | -| filter | 表示该模板因为模板标题同名被后台过滤 | -| acceptWithAudio | 表示用户接收订阅消息并开启了语音提醒 | - -## 示例代码 - -```tsx -Taro.requestSubscribeDeviceMessage({ - tmplIds: ['xxxxx'], - sn: 'xxxx', - snTicket: 'xxxxx', - modelId: 'xxx', - success(res) { - console.log(res) - }, - fail(res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeMessage.md b/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeMessage.md deleted file mode 100644 index da243b392b87..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/subscribe-message/requestSubscribeMessage.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.requestSubscribeMessage(option) -sidebar_label: requestSubscribeMessage ---- - -请求订阅消息 - -注意：[2.8.2](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始，用户发生点击行为或者发起支付回调后，才可以调起订阅消息界面。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| tmplIds | `string[]` | 是 | 需要订阅的消息模板的id的集合（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### FailCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | `number` | 接口调用失败错误码 | -| errMsg | `string` | 接口调用失败错误信息 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| [TEMPLATE_ID] | "accept" or "reject" or "ban" | 动态的键，即模板id | -| errMsg | `string` | 接口调用成功时errMsg值为'requestSubscribeMessage:ok' | - -#### 示例代码 - -表示用户同意订阅 zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE 这条消息 - -```json -{ - "errMsg": "requestSubscribeMessage:ok", - "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept" -} -``` - -### TemplateReflex - -模版消息订阅类型 - -| 参数 | 说明 | -| --- | --- | -| accept | 表示用户同意订阅该条id对应的模板消息 | -| reject | 表示用户拒绝订阅该条id对应的模板消息 | -| ban | 表示已被后台封禁 | -| filter | 表示该模板因为模板标题同名被后台过滤 | - -## 示例代码 - -```tsx -Taro.requestSubscribeMessage({ - tmplIds: [''], - success: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/user-info/UserInfo.md b/versioned_docs/version-4.x/apis/open-api/user-info/UserInfo.md deleted file mode 100644 index c0aeaf4d4c2d..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/user-info/UserInfo.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UserInfo -sidebar_label: UserInfo ---- - -用户信息 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/UserInfo.html) - -## 方法 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| nickName | `string` | 是 | 用户昵称 | -| avatarUrl | `string` | 是 | 用户头像图片的 URL。URL 最后一个数值代表正方形头像大小（有 0、46、64、96、132 数值可选，0 代表 640x640 的正方形头像，46 表示 46x46 的正方形头像，剩余数值以此类推。默认132），用户没有头像时该项为空。若用户更换头像，原有头像 URL 将失效。 | -| gender | `keyof Gender` | 否 | 用户性别。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) | -| country | `string` | 是 | 用户所在国家。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) | -| province | `string` | 是 | 用户所在省份。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) | -| city | `string` | 是 | 用户所在城市。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) | -| language | `keyof Language` | 是 | 显示 country，province，city 所用的语言。强制返回 “zh_CN”，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) | - -## 参数 - -### Language - -| 参数 | 类型 | -| --- | --- | -| en | `"英文"` | -| zh_CN | `"简体中文"` | -| zh_TW | `"繁体中文"` | - -### Gender - -| 参数 | 类型 | -| --- | --- | -| 0 | `"未知"` | -| 1 | `"男性"` | -| 2 | `"女性"` | diff --git a/versioned_docs/version-4.x/apis/open-api/user-info/getUserInfo.md b/versioned_docs/version-4.x/apis/open-api/user-info/getUserInfo.md deleted file mode 100644 index 8fc67d679df2..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/user-info/getUserInfo.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: Taro.getUserInfo(option) -sidebar_label: getUserInfo ---- - -获取用户信息。 - -**接口调整说明** -在用户未授权过的情况下调用此接口，将不再出现授权弹窗，会直接进入 fail 回调（详见[《公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01))。在用户已授权的情况下调用此接口，可成功获取用户信息。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/wx.getUserInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| lang | `keyof Language` | 否 | 显示用户信息的语言 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| withCredentials | `boolean` | 否 | 是否带上登录态信息。当 withCredentials 为 true 时，要求此前有调用过 Taro.login 且登录态尚未过期，此时返回的数据会包含 encryptedData, iv 等敏感信息；当 withCredentials 为 false 时，不要求有登录态，返回的数据不包含 encryptedData, iv 等敏感信息。 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cloudID | `string` | 否 | 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | -| encryptedData | `string` | 是 | 包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) | -| iv | `string` | 是 | 加密算法的初始向量，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) | -| rawData | `string` | 是 | 不包括敏感信息的原始数据字符串，用于计算签名 | -| signature | `string` | 是 | 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| userInfo | `UserInfo` | 是 | 用户信息对象，不包含 openid 等敏感信息 | -| errMsg | `string` | 是 | 调用结果 | - -## 示例代码 - -```tsx -// 必须是在用户已经授权的情况下调用 - -Taro.getUserInfo({ - success: function(res) { - var userInfo = res.userInfo - var nickName = userInfo.nickName - var avatarUrl = userInfo.avatarUrl - var gender = userInfo.gender //性别 0：未知、1：男、2：女 - var province = userInfo.province - var city = userInfo.city - var country = userInfo.country - } -}) -``` - -敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。 -获取得到的开放数据为以下 json 结构： - -```json -{ - "openId": "OPENID", - "nickName": "NICKNAME", - "gender": GENDER, - "city": "CITY", - "province": "PROVINCE", - "country": "COUNTRY", - "avatarUrl": "AVATARURL", - "unionId": "UNIONID", - "watermark": { - "appid":"APPID", - "timestamp": TIMESTAMP - } -} -``` diff --git a/versioned_docs/version-4.x/apis/open-api/user-info/getUserProfile.md b/versioned_docs/version-4.x/apis/open-api/user-info/getUserProfile.md deleted file mode 100644 index ef13f1f60219..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/user-info/getUserProfile.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Taro.getUserProfile(option) -sidebar_label: getUserProfile ---- - -> 最低 Taro 版本: 2.2.17+，3.0.29+ - -获取用户信息。每次请求都会弹出授权窗口，用户同意后返回 `userInfo`。 - -若开发者需要获取用户的个人信息（头像、昵称、性别与地区），可以通过 Taro.getUserProfile 接口进行获取， - -微信该接口从基础库 **2.10.4** 版本开始支持，该接口只返回用户个人信息，不包含用户身份标识符。该接口中 desc 属性（声明获取用户个人信息后的用途）后续会展示在弹窗中，请开发者谨慎填写。 - -开发者每次通过该接口获取用户个人信息均需用户确认，请开发者妥善保管用户快速填写的头像昵称，避免重复弹窗。 - -[微信端调整背景和说明，请参考文档](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/wx.getUserProfile.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| lang | `keyof Language` | 否 | 显示用户信息的语言 | -| desc | `string` | 是 | 声明获取用户个人信息后的用途，不超过30个字符 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| userInfo | `UserInfo` | 用户信息对象 | -| rawData | `string` | 不包括敏感信息的原始数据字符串，用于计算签名 | -| signature | `string` | 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| encryptedData | `string` | 包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) | -| iv | `string` | 加密算法的初始向量，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) | -| cloudID | `string` | 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细 [见云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | - -## 示例代码 - -推荐使用 Taro.getUserProfile 获取用户信息，开发者每次通过该接口获取用户个人信息均需用户确认 - -```tsx -Taro.getUserProfile({ - desc: '用于完善会员资料', // 声明获取用户个人信息后的用途，后续会展示在弹窗中，请谨慎填写 - success: (res) => { - // 开发者妥善保管用户快速填写的头像昵称，避免重复弹窗 - this.setState({ - userInfo: res.userInfo, - hasUserInfo: true - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/open-api/werun/getWeRunData.md b/versioned_docs/version-4.x/apis/open-api/werun/getWeRunData.md deleted file mode 100644 index f15e29f6249e..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/werun/getWeRunData.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.getWeRunData(option) -sidebar_label: getWeRunData ---- - -获取用户过去三十天微信运动步数。需要先调用 Taro.login 接口。步数信息会在用户主动进入小程序时更新。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.getWeRunData.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cloudID | `string` | 否 | 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | -| encryptedData | `string` | 是 | 包括敏感数据在内的完整用户信息的加密数据，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html)。解密后得到的数据结构见后文 | -| iv | `string` | 是 | 加密算法的初始向量，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| errMsg | `string` | 是 | 调用结果 | - -## 示例代码 - -```tsx -Taro.getWeRunData({ - success: function (res) { - // 拿 encryptedData 到开发者后台解密开放数据 - const encryptedData = res.encryptedData - // 或拿 cloudID 通过云调用直接获取开放数据 - const cloudID = res.cloudID - } -}) -``` - -**开放数据 JSON 结构** -敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。 -获取得到的开放数据为以下 json 结构： - -```json -{ - "stepInfoList": [ - { - "timestamp": 1445866601, - "step": 100 - }, - { - "timestamp": 1445876601, - "step": 120 - } - ] -} -``` - -stepInfoList 中，每一项结构如下： - -| 属性 | 类型 | 说明 | -| --- | ---- | --- | -| timestamp | number | 时间戳，表示数据对应的时间 | -| step | number | 微信运动步数 | diff --git a/versioned_docs/version-4.x/apis/open-api/werun/shareToWeRun.md b/versioned_docs/version-4.x/apis/open-api/werun/shareToWeRun.md deleted file mode 100644 index fd61f9cfec92..000000000000 --- a/versioned_docs/version-4.x/apis/open-api/werun/shareToWeRun.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.shareToWeRun(option) -sidebar_label: shareToWeRun ---- - -分享数据到微信运动。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.shareToWeRun.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| recordList | `record[]` | 是 | 运动数据列表 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### record - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| typeId | `number` | 运动项目id | -| time | `number` | 运动时长 | -| distance | `number` | 运动距离 | -| calorie | `number` | 消耗卡路里 | diff --git a/versioned_docs/version-4.x/apis/payment/faceVerifyForPay.md b/versioned_docs/version-4.x/apis/payment/faceVerifyForPay.md deleted file mode 100644 index 7f471dbbc097..000000000000 --- a/versioned_docs/version-4.x/apis/payment/faceVerifyForPay.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.faceVerifyForPay(option) -sidebar_label: faceVerifyForPay ---- - -支付各个安全场景验证人脸 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/payment/wx.faceVerifyForPay.html) - -## 类型 - -```tsx -(option: any) => Promise -``` - -## 示例代码 - -```tsx -Taro.faceVerifyForPay(params).then(...) -``` diff --git a/versioned_docs/version-4.x/apis/payment/requestOrderPayment.md b/versioned_docs/version-4.x/apis/payment/requestOrderPayment.md deleted file mode 100644 index acc53b33d73a..000000000000 --- a/versioned_docs/version-4.x/apis/payment/requestOrderPayment.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Taro.requestOrderPayment(option) -sidebar_label: requestOrderPayment ---- - -创建自定义版交易组件订单，并发起支付。 仅接入了[自定义版交易组件](https://developers.weixin.qq.com/miniprogram/dev/framework/ministore/minishopopencomponent2/Introduction2)的小程序需要使用，普通小程序可直接使用 `Taro.requestPayment`。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/payment/wx.requestOrderPayment.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeStamp | `string` | 是 | 时间戳，从 1970 年 1 月 1 日 00:00:00 至今的秒数，即当前的时间 | -| nonceStr | `string` | 是 | 随机字符串，长度为32个字符以下 | -| package | `string` | 是 | 统一下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=*** | -| orderInfo | `any` | 否 | 订单信息，仅在需要校验的场景下需要传递，具体见[接口说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ministore/minishopopencomponent2/API/order/requestOrderPayment) | -| extUserUin | `string` | 否 | 外部 APP 用户 ID | -| signType | `keyof SignType` | 否 | 签名算法 | -| paySign | `string` | 是 | 签名，具体签名方案参见 [小程序支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_7&index=3) | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SignType - -| 参数 | 说明 | -| --- | --- | -| MD5 | 仅在微信支付 v2 版本接口适用 | -| HMAC-SHA256 | 仅在微信支付 v2 版本接口适用 | -| RSA | 仅在微信支付 v3 版本接口适用 | - -## 示例代码 - -除 orderInfo 以外，其余字段与 [Taro.requestPayment](./requestPayment) 一致 - -```tsx -Taro.requestOrderPayment({ - orderInfo: {}, - timeStamp: '', - nonceStr: '', - package: '', - signType: 'MD5', - paySign: '', - success (res) { }, - fail (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/payment/requestPayment.md b/versioned_docs/version-4.x/apis/payment/requestPayment.md deleted file mode 100644 index 00381e7d87eb..000000000000 --- a/versioned_docs/version-4.x/apis/payment/requestPayment.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Taro.requestPayment(option) -sidebar_label: requestPayment ---- - -发起微信支付。了解更多信息，请查看[微信支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_3&index=1) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/payment/wx.requestPayment.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| timeStamp | `string` | 是 | 时间戳，从 1970 年 1 月 1 日 00:00:00 至今的秒数，即当前的时间 | -| nonceStr | `string` | 是 | 随机字符串，长度为32个字符以下 | -| package | `string` | 是 | 统一下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=*** | -| signType | `keyof SignType` | 否 | 签名算法 | -| paySign | `string` | 是 | 签名，具体签名方案参见 [小程序支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_7&index=3) | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SignType - -| 参数 | 说明 | -| --- | --- | -| MD5 | 仅在微信支付 v2 版本接口适用 | -| HMAC-SHA256 | 仅在微信支付 v2 版本接口适用 | -| RSA | 仅在微信支付 v3 版本接口适用 | - -## 示例代码 - -```tsx -Taro.requestPayment({ - timeStamp: '', - nonceStr: '', - package: '', - signType: 'MD5', - paySign: '', - success: function (res) { }, - fail: function (res) { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/qq/openQzonePublish.md b/versioned_docs/version-4.x/apis/qq/openQzonePublish.md deleted file mode 100644 index 61a3b510c666..000000000000 --- a/versioned_docs/version-4.x/apis/qq/openQzonePublish.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Taro.openQzonePublish(option) -sidebar_label: openQzonePublish ---- - -此接口可打开手Q说说发表界面，并将文字内容和图片/视频内容传递到手Q说说发表界面。 -```tsx -Taro.openQzonePublish({ - footnote: '使用同款滤镜', - path: 'pages/index/index', - text: '我爱中国', - media: [ - { - type: 'photo', - path: 'qqfile://1.png' - }, - { - type: 'video', - path: 'qqfile://2.mp4' - } - ] -}) -``` - -支持情况： - -> [参考文档](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_openQzonePublish.html) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| text | `string` | 传递的文字内容 | -| media | `Media[]` | 传递的视频/图片内容，显示顺序为元素下标顺序 | -| path | `string` | 说说小尾巴跳转到的页面路径，不填则默认跳到主页 | -| footnote | `string` | 说说小尾巴显示的文案，不填则默认显示小程序的简介文案 | - -### Media - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| type | `MediaType` | 图片填"photo"，视频填"video" | -| path | `string` | 文件路径，必须为本地文件 | - -### MediaType - -```tsx -"photo" | "video" -``` diff --git a/versioned_docs/version-4.x/apis/route/EventChannel.md b/versioned_docs/version-4.x/apis/route/EventChannel.md deleted file mode 100644 index 95a1bcf597a3..000000000000 --- a/versioned_docs/version-4.x/apis/route/EventChannel.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: EventChannel -sidebar_label: EventChannel ---- - -页面间事件通信通道 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.html) - -## 方法 - -### emit - -触发一个事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.emit.html) - -```tsx -(eventName: string, ...args: any) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| args | `any` | 事件参数 | - -### on - -持续监听一个事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.on.html) - -```tsx -(eventName: string, fn: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| fn | `TaroGeneral.EventCallback` | 事件监听函数 | - -### once - -监听一个事件一次，触发后失效 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.once.html) - -```tsx -(eventName: string, fn: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| fn | `TaroGeneral.EventCallback` | 事件监听函数 | - -### off - -取消监听一个事件。给出第二个参数时，只取消给出的监听函数，否则取消所有监听函数 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.off.html) - -```tsx -(eventName: string, fn: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| fn | `TaroGeneral.EventCallback` | 事件监听函数 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| EventChannel | ✔️ | | | | -| EventChannel.emit | ✔️ | | | | -| EventChannel.on | ✔️ | | | | -| EventChannel.once | ✔️ | | | | -| EventChannel.off | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/route/navigateBack.md b/versioned_docs/version-4.x/apis/route/navigateBack.md deleted file mode 100644 index 60b2780b7423..000000000000 --- a/versioned_docs/version-4.x/apis/route/navigateBack.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.navigateBack(option) -sidebar_label: navigateBack ---- - -关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈，决定需要返回几层。 - -支持情况： - -> H5: 若入参 delta 大于现有页面数时，返回应用打开的第一个页面（如果想要返回首页请使用 reLaunch 方法）。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.navigateBack.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| delta | `number` | 否 | 返回的页面数，如果 delta 大于现有页面数，则返回到首页。 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -// 注意：调用 navigateTo 跳转时，调用该方法的页面会被加入堆栈，而 redirectTo 方法则不会。见下方示例代码 -// 此处是A页面 -Taro.navigateTo({ - url: 'B?id=1' -}) -// 此处是B页面 -Taro.navigateTo({ - url: 'C?id=1' -}) -// 在C页面内 navigateBack，将返回A页面 -Taro.navigateBack({ - delta: 2 -}) -``` diff --git a/versioned_docs/version-4.x/apis/route/navigateTo.md b/versioned_docs/version-4.x/apis/route/navigateTo.md deleted file mode 100644 index 7e85f96b5d4f..000000000000 --- a/versioned_docs/version-4.x/apis/route/navigateTo.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Taro.navigateTo(option) -sidebar_label: navigateTo ---- - -保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 Taro.navigateBack 可以返回到原页面。小程序中页面栈最多十层。 - -支持情况： - -> H5: 未针对 tabbar 页面做限制处理 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.navigateTo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 需要跳转的应用内非 tabBar 的页面的路径, 路径后可以带参数。参数与路径之间使用 `?` 分隔，参数键与参数值用 `=` 相连，不同参数用 `&` 分隔；如 'path?key=value&key2=value2' | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| events | `TaroGeneral.IAnyObject` | 否 | 页面间通信接口，用于监听被打开页面发送到当前页面的数据。 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: any) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.navigateTo({ - url: 'test?id=1', - events: { - // 为指定事件添加一个监听器，获取被打开页面传送到当前页面的数据 - acceptDataFromOpenedPage: function(data) { - console.log(data) - }, - someEvent: function(data) { - console.log(data) - } - ... - }, - success: function (res) { - // 通过eventChannel向被打开页面传送数据 - res.eventChannel.emit('acceptDataFromOpenerPage', { data: 'test' }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/route/reLaunch.md b/versioned_docs/version-4.x/apis/route/reLaunch.md deleted file mode 100644 index fd7b888bcd82..000000000000 --- a/versioned_docs/version-4.x/apis/route/reLaunch.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.reLaunch(option) -sidebar_label: reLaunch ---- - -关闭所有页面，打开到应用内的某个页面 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.reLaunch.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 需要跳转的应用内页面路径，路径后可以带参数。参数与路径之间使用?分隔，参数键与参数值用=相连，不同参数用&分隔；如 'path?key=value&key2=value2' | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.reLaunch({ - url: 'test?id=1' -}) -``` diff --git a/versioned_docs/version-4.x/apis/route/redirectTo.md b/versioned_docs/version-4.x/apis/route/redirectTo.md deleted file mode 100644 index 4c0611089ff8..000000000000 --- a/versioned_docs/version-4.x/apis/route/redirectTo.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.redirectTo(option) -sidebar_label: redirectTo ---- - -关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。 - -支持情况： - -> H5: 未针对 tabbar 页面做限制处理 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.redirectTo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 需要跳转的应用内非 tabBar 的页面的路径, 路径后可以带参数。参数与路径之间使用 `?` 分隔，参数键与参数值用 `=` 相连，不同参数用 `&` 分隔；如 'path?key=value&key2=value2' | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.redirectTo({ - url: 'test?id=1' -}) -``` diff --git a/versioned_docs/version-4.x/apis/route/switchTab.md b/versioned_docs/version-4.x/apis/route/switchTab.md deleted file mode 100644 index 7dee8bb82262..000000000000 --- a/versioned_docs/version-4.x/apis/route/switchTab.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.switchTab(option) -sidebar_label: switchTab ---- - -跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.switchTab.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| url | `string` | 是 | 需要跳转的 tabBar 页面的路径（需在 app.json 的 [tabBar](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#tabbar) 字段定义的页面），路径后不能带参数。 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```json -{ - "tabBar": { - "list": [{ - "pagePath": "index", - "text": "首页" - },{ - "pagePath": "other", - "text": "其他" - }] - } -} -``` - -```tsx -Taro.switchTab({ - url: '/index' -}) -``` diff --git a/versioned_docs/version-4.x/apis/share/authPrivateMessage.md b/versioned_docs/version-4.x/apis/share/authPrivateMessage.md deleted file mode 100644 index 20b390f3a1d7..000000000000 --- a/versioned_docs/version-4.x/apis/share/authPrivateMessage.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Taro.authPrivateMessage(option) -sidebar_label: authPrivateMessage ---- - -验证私密消息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.authPrivateMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| shareTicket | `string` | 是 | shareTicket | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cloudID | `string` | 否 | 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | -| encryptedData | `string` | 是 | 包括敏感数据在内的完整转发信息的加密数据，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| errMsg | `string` | 是 | 错误信息 | -| iv | `string` | 是 | 加密算法的初始向量，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | - -## 示例代码 - -```tsx -Taro.authPrivateMessage({ - shareTicket: 'xxxxxx', - success(res) { - console.log('authPrivateMessage success', res) - // res - // { - // errMsg: 'authPrivateMessage:ok' - // valid: true - // iv: 'xxxx', - // encryptedData: 'xxxxxx' - // } - }, - fail(res) { - console.log('authPrivateMessage fail', res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/share/getShareInfo.md b/versioned_docs/version-4.x/apis/share/getShareInfo.md deleted file mode 100644 index 3bf3b0671bb2..000000000000 --- a/versioned_docs/version-4.x/apis/share/getShareInfo.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Taro.getShareInfo(option) -sidebar_label: getShareInfo ---- - -获取转发详细信息 - -**Tips** -- 如需要展示群名称，可以使用[开放数据组件](/docs/components/open/open-data) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.getShareInfo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| shareTicket | `string` | 是 | shareTicket | -| timeout | `number` | 否 | 超时时间，单位 ms | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cloudID | `string` | 否 | 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) | -| encryptedData | `string` | 是 | 包括敏感数据在内的完整转发信息的加密数据，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | -| errMsg | `string` | 是 | 错误信息 | -| iv | `string` | 是 | 加密算法的初始向量，详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) | - -## 示例代码 - -敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。 -获取得到的开放数据为以下 json 结构（其中 openGId 为当前群的唯一标识）： -```json -{ - "openGId": "OPENGID" -} -``` diff --git a/versioned_docs/version-4.x/apis/share/hideShareMenu.md b/versioned_docs/version-4.x/apis/share/hideShareMenu.md deleted file mode 100644 index 8337a9e27266..000000000000 --- a/versioned_docs/version-4.x/apis/share/hideShareMenu.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.hideShareMenu(option) -sidebar_label: hideShareMenu ---- - -隐藏当前页面的转发按钮 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.hideShareMenu.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| menus | `string[]` | 否 | 本接口为 Beta 版本，暂只在 Android 平台支持。需要隐藏的转发按钮名称列表，默认['shareAppMessage', 'shareTimeline']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 | -| success | `(result: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.hideShareMenu() -``` diff --git a/versioned_docs/version-4.x/apis/share/offCopyUrl.md b/versioned_docs/version-4.x/apis/share/offCopyUrl.md deleted file mode 100644 index d3ce6ae4f93d..000000000000 --- a/versioned_docs/version-4.x/apis/share/offCopyUrl.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Taro.offCopyUrl(callback) -sidebar_label: offCopyUrl ---- - -取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件 - -> 本接口为 Beta 版本，暂只在 Android 平台支持。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.offCopyUrl.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 | diff --git a/versioned_docs/version-4.x/apis/share/onCopyUrl.md b/versioned_docs/version-4.x/apis/share/onCopyUrl.md deleted file mode 100644 index 298cc792457b..000000000000 --- a/versioned_docs/version-4.x/apis/share/onCopyUrl.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.onCopyUrl(callback) -sidebar_label: onCopyUrl ---- - -监听用户点击右上角菜单的「复制链接」按钮时触发的事件 - -> 本接口为 Beta 版本，暂只在 Android 平台支持。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.onCopyUrl.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 | - -### Callback - -用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| query | `string` | 用短链打开小程序时当前页面携带的查询字符串。小程序中使用时，应在进入页面时调用 `Taro.onCopyUrl` 自定义 `query`，退出页面时调用 `Taro.offCopyUrl`，防止影响其它页面。 | diff --git a/versioned_docs/version-4.x/apis/share/shareFileMessage.md b/versioned_docs/version-4.x/apis/share/shareFileMessage.md deleted file mode 100644 index 066758dc8dfc..000000000000 --- a/versioned_docs/version-4.x/apis/share/shareFileMessage.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.shareFileMessage(option) -sidebar_label: shareFileMessage ---- - -转发文件到聊天 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.shareFileMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要分享的视频地址，必须为本地路径或临时路径 | -| fileName | `string` | 否 | 自定义文件名，若留空则使用 filePath 中的文件名 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | diff --git a/versioned_docs/version-4.x/apis/share/shareVideoMessage.md b/versioned_docs/version-4.x/apis/share/shareVideoMessage.md deleted file mode 100644 index 84878204828b..000000000000 --- a/versioned_docs/version-4.x/apis/share/shareVideoMessage.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Taro.shareVideoMessage(option) -sidebar_label: shareVideoMessage ---- - -转发视频到聊天 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.shareVideoMessage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| videoPath | `string` | 是 | 要分享的视频地址，必须为本地路径或临时路径 | -| thumbPath | `string` | 否 | 缩略图路径，若留空则使用视频首帧 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -callback 写法 - -```tsx -Taro.downloadFile({ - url: URL, // 下载url - success (res) { - // 下载完成后转发 - Taro.shareVideoMessage({ - videoPath: res.tempFilePath, - success() {}, - fail: console.error, - }) - }, - fail: console.error, -}) -``` - -async await 写法 - -```tsx -const { tempFilePath } = await Taro.downloadFile({ - url: URL, // 下载url -}) -// 下载完成后转发 -await Taro.shareVideoMessage({ - videoPath: res.tempFilePath, -}) -``` diff --git a/versioned_docs/version-4.x/apis/share/showShareImageMenu.md b/versioned_docs/version-4.x/apis/share/showShareImageMenu.md deleted file mode 100644 index 69f919bac9a9..000000000000 --- a/versioned_docs/version-4.x/apis/share/showShareImageMenu.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Taro.showShareImageMenu(option) -sidebar_label: showShareImageMenu ---- - -打开分享图片弹窗，可以将图片发送给朋友、收藏或下载 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.showShareImageMenu.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| path | `string` | 是 | 要分享的图片地址，必须为本地路径或临时路径 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.downloadFile({ - url: 'https://res.wx.qq.com/wxdoc/dist/assets/img/demo.ef5c5bef.jpg', - success: (res) => { - Taro.showShareImageMenu({ - path: res.tempFilePath - }) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/share/showShareMenu.md b/versioned_docs/version-4.x/apis/share/showShareMenu.md deleted file mode 100644 index 4dd0177f1d8b..000000000000 --- a/versioned_docs/version-4.x/apis/share/showShareMenu.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.showShareMenu(option) -sidebar_label: showShareMenu ---- - -显示当前页面的转发按钮 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.showShareMenu.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| withShareTicket | `boolean` | 否 | 是否使用带 shareTicket 的转发[详情](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | -| showShareItems | `string[]` | 否 | QQ小程序分享功能，支持分享到QQ、QQ空间、微信好友、微信朋友圈
API 支持度: weapp, qq
qq: QQ支持的值： ['qq', 'qzone', 'wechatFriends', 'wechatMoment']
weapp: 微信支持：['wechatFriends', 'wechatMoment'] / ['shareAppMessage', 'shareTimeline'] | - -## 示例代码 - -```tsx -Taro.showShareMenu({ - withShareTicket: true -}) -``` diff --git a/versioned_docs/version-4.x/apis/share/updateShareMenu.md b/versioned_docs/version-4.x/apis/share/updateShareMenu.md deleted file mode 100644 index 3f5e4c9bdce9..000000000000 --- a/versioned_docs/version-4.x/apis/share/updateShareMenu.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Taro.updateShareMenu(option) -sidebar_label: updateShareMenu ---- - -更新转发属性 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.updateShareMenu.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| activityId | `string` | 否 | 动态消息的 activityId。通过 [updatableMessage.createActivityId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/updatable-message/updatableMessage.createActivityId.html) 接口获取 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| isUpdatableMessage | `boolean` | 否 | 是否是动态消息，详见[动态消息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share/updatable-message.html) | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| templateInfo | `UpdatableMessageFrontEndTemplateInfo` | 否 | 动态消息的模板信息 | -| withShareTicket | `boolean` | 否 | 是否使用带 shareTicket 的转发[详情](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html) | - -### UpdatableMessageFrontEndTemplateInfo - -动态消息的模板信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| parameterList | `UpdatableMessageFrontEndParameter[]` | 参数列表 | - -### UpdatableMessageFrontEndParameter - -参数列表 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| name | `string` | 参数名 | -| value | `string` | 参数值 | - -## 示例代码 - -```tsx -Taro.updateShareMenu({ - withShareTicket: true, - success () { } -}) -``` diff --git a/versioned_docs/version-4.x/apis/skyline/Snapshot.md b/versioned_docs/version-4.x/apis/skyline/Snapshot.md deleted file mode 100644 index 0f7be9e11efc..000000000000 --- a/versioned_docs/version-4.x/apis/skyline/Snapshot.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Snapshot -sidebar_label: Snapshot ---- - -Snapshot 实例，可通过 SelectorQuery 获取。 - -Snapshot 通过 id 跟一个 snapshot 组件绑定，操作对应的 snapshot 组件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/skyline/Snapshot.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| width | `number` | 画布宽度 | -| height | `number` | 画布高度 | - -### takeSnapshot - -对 snapshot 组件子树进行截图 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/skyline/Snapshot.takeSnapshot.html) - -```tsx -(option: Option) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -## 参数 - -### TakeSnapshot - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| type | `string` | 是 | 截图导出类型，'file' 保存到临时文件目录或 'arraybuffer' 返回图片二进制数据，默认值为 'file' | -| format | `string` | 是 | 截图文件格式，'rgba' 或 'png'，默认值为 'png' | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -#### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tempFilePath | `string` | 截图保存的临时文件路径，当 type 为 file 该字段生效 | -| data | `string` | 截图对应的二进制数据，当 type 为 arraybuffer 该字段生效 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Snapshot | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchData.md b/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchData.md deleted file mode 100644 index ae61089834a2..000000000000 --- a/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchData.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Taro.getBackgroundFetchData(option) -sidebar_label: getBackgroundFetchData ---- - -拉取 backgroundFetch 客户端缓存数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchData.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fetchType | `string` | 是 | 缓存数据类别
weapp: 取值为 periodic
qq: 取值为 periodic
alipay: 取值为 pre: 数据预拉取; jsapiPre: API 预调用（目前仅支持地理位置预拉取） | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| fetchedData | string or Object | 是 | 缓存数据
alipay: Object | -| timeStamp | `number` | 是 | 客户端拿到缓存数据的时间戳 ms。(iOS 时间戳存在异常，8.0.27 修复) | -| path | `string` | 是 | 小程序页面路径 | -| query | `string` | 是 | 传给页面的 query 参数 | -| scene | `number` | 是 | 进入小程序的场景值 | -| fetchType | `string` | 否 | 缓存数据类型，与入参 fetchType 一致
API 支持度: alipay | -| timestamp | `number` | 否 | 缓存数据的时间戳。单位：ms。
API 支持度: alipay | diff --git a/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchToken.md b/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchToken.md deleted file mode 100644 index e297ffe22010..000000000000 --- a/versioned_docs/version-4.x/apis/storage/background-fetch/getBackgroundFetchToken.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Taro.getBackgroundFetchToken(option) -sidebar_label: getBackgroundFetchToken ---- - -获取设置过的自定义登录态。若无，则返回 fail。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchToken.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| token | `string` | 自定义的登录态 | -| errMsg | `string` | 接口调用结果 | diff --git a/versioned_docs/version-4.x/apis/storage/background-fetch/onBackgroundFetchData.md b/versioned_docs/version-4.x/apis/storage/background-fetch/onBackgroundFetchData.md deleted file mode 100644 index 38d60616ac57..000000000000 --- a/versioned_docs/version-4.x/apis/storage/background-fetch/onBackgroundFetchData.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.onBackgroundFetchData(option) -sidebar_label: onBackgroundFetchData ---- - -收到 backgroundFetch 数据时的回调 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.onBackgroundFetchData.html) - -## 类型 - -```tsx -(option?: Option | Callback) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | Option or Callback | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### Callback - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| fetchType | `string` | 缓存数据类别，取值为 periodic 或 pre | -| fetchedData | `string` | 缓存数据 | -| timeStamp | `number` | 客户端拿到缓存数据的时间戳 | -| path | `string` | 小程序页面路径 | -| query | `string` | 传给页面的 query 参数 | -| scene | `number` | 进入小程序的场景值 | diff --git a/versioned_docs/version-4.x/apis/storage/background-fetch/setBackgroundFetchToken.md b/versioned_docs/version-4.x/apis/storage/background-fetch/setBackgroundFetchToken.md deleted file mode 100644 index fd6b58dc1eb5..000000000000 --- a/versioned_docs/version-4.x/apis/storage/background-fetch/setBackgroundFetchToken.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.setBackgroundFetchToken(option) -sidebar_label: setBackgroundFetchToken ---- - -设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.setBackgroundFetchToken.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| token | `string` | 是 | 自定义的登录态 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/storage/batchGetStorage.md b/versioned_docs/version-4.x/apis/storage/batchGetStorage.md deleted file mode 100644 index 3760e6b476db..000000000000 --- a/versioned_docs/version-4.x/apis/storage/batchGetStorage.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.batchGetStorage(option) -sidebar_label: batchGetStorage ---- - -从本地缓存中异步批量获取指定 key 的内容。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| keyList | `string[]` | 是 | 本地缓存中指定的 keyList | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.batchGetStorage({ - keyList: ['key'], - success(res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/storage/batchGetStorageSync.md b/versioned_docs/version-4.x/apis/storage/batchGetStorageSync.md deleted file mode 100644 index 1bcf9a5b6001..000000000000 --- a/versioned_docs/version-4.x/apis/storage/batchGetStorageSync.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.batchGetStorageSync(keyList) -sidebar_label: batchGetStorageSync ---- - -从本地缓存中同步批量获取指定 key 的内容。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html) - -## 类型 - -```tsx -(keyList: string[]) => T[] -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| keyList | `T` | 本地缓存中指定的 key 数组 | - -## 示例代码 - -```tsx -try { - var valueList = Taro.batchGetStorageSync(['key']) - if (valueList) { - // Do something with return value - } -} catch (e) { - // Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/storage/batchSetStorage.md b/versioned_docs/version-4.x/apis/storage/batchSetStorage.md deleted file mode 100644 index 02ca4eb4166f..000000000000 --- a/versioned_docs/version-4.x/apis/storage/batchSetStorage.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Taro.batchSetStorage(option) -sidebar_label: batchSetStorage ---- - -将数据批量存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。 -除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。 -单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| kvList | `kv[]` | 是 | [{ key, value }] | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### kv - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | key 本地缓存中指定的 key | -| value | `any` | data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。 | - -## 示例代码 - -```tsx -Taro.batchGetStorage({ - keyList: ['key'] - success(res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/storage/batchSetStorageSync.md b/versioned_docs/version-4.x/apis/storage/batchSetStorageSync.md deleted file mode 100644 index 0a5e3fcb185c..000000000000 --- a/versioned_docs/version-4.x/apis/storage/batchSetStorageSync.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.batchSetStorageSync(option) -sidebar_label: batchSetStorageSync ---- - -将数据批量存储在本地缓存中指定的 key 中。 -会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。 -单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| kvList | `kv[]` | [{ key, value }] | - -### kv - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | key 本地缓存中指定的 key | -| value | `any` | data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。 | - -## 示例代码 - -```tsx -try { - Taro.batchSetStorageSync([{key: 'key', value: 'value'}]) -} catch (e) { } -``` diff --git a/versioned_docs/version-4.x/apis/storage/cache-manager/CacheManager.md b/versioned_docs/version-4.x/apis/storage/cache-manager/CacheManager.md deleted file mode 100644 index 834d79ea5215..000000000000 --- a/versioned_docs/version-4.x/apis/storage/cache-manager/CacheManager.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -title: CacheManager -sidebar_label: CacheManager ---- - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| mode | `keyof Mode` | 当前缓存模式 | -| origin | `string` | 全局 origin | -| maxAge | `number` | 全局缓存有效时间 | -| state | `keyof State` | 当前缓存管理器状态 | - -### addRule - -添加规则 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.addRule.html) - -```tsx -(option: AddRuleOption) => string -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddRuleOption` | - -#### 示例代码 - -```tsx -const ruleId = cacheManager.addRule({ - id: 'haha-rule', - method: 'GET', - url: '/haha', - maxAge: 123455, - dataSchema: [ - // data 字段的匹配，默认为空，表示不匹配 - // 类型可以是：string、number、boolean、null、object、any（表示任意类型均可），以及这些类型的数组表示方式 - {name: 'aaa', schema: {type: 'string'}}, // 类型为 string - {name: 'bbb', schema: [{type: 'number'}, {type: 'string'}]}, // 类型为 number, string - {name: 'ccc', schema: {type: 'string', value: 'abc'}}, // 值为 abc - {name: 'ddd', schema: {type: 'string', value: /(abc|cba)/ig}}, // 值符合该正则匹配，如果该值不是字符串类型，则会被尝试转成字符串后再进行比较 - {name: 'ddd', schema: {type: 'string', value: val => val === '123'}}, // 传入函数来校验值 - {name: 'eee', schema: {type: 'object', value: [{ // 类型为对象，则通过嵌套的方式来逐层校验 - name: 'aaa', schema: {type: 'string'}, - // ... - // 嵌套 dataSchema，同上面的方式一样来匹配嵌套的对象 - }]}}, - {name: 'fff', schema: {type: 'string[]'}}, // 类型为 string 数组 - {name: 'ggg', schema: {type: 'any'}}, // 类型为任意类型 - {name: 'hhh', schema: {type: 'any[]'}}, // 类型为任意类型的数组 - ] -}) -``` - -### addRules - -批量添加规则 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.addRules.html) - -```tsx -(option: AddRulesOption) => string[] -``` - -| 参数 | 类型 | -| --- | --- | -| option | `AddRulesOption` | - -### clearCaches - -清空所有缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.clearCaches.html) - -```tsx -() => void -``` - -### clearRules - -清空所有规则，同时会删除对应规则下所有缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.clearRules.html) - -```tsx -() => void -``` - -### deleteCache - -删除缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteCache.html) - -```tsx -(id: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `string` | 缓存 id | - -### deleteCaches - -批量删除缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteCaches.html) - -```tsx -(ids: string[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ids | `string[]` | 缓存 id 列表 | - -### deleteRule - -删除规则，同时会删除对应规则下所有缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRule.html) - -```tsx -(id: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| id | `string` | 规则 id | - -### deleteRules - -批量删除规则，同时会删除对应规则下所有缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRules.html) - -```tsx -(ids: string[]) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ids | `string[]` | 规则 id 列表 | - -### match - -匹配命中的缓存规则，一般需要和 request 事件搭配使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.match.html) - -```tsx -(option: MatchOption) => MatchResult -``` - -| 参数 | 类型 | -| --- | --- | -| option | `MatchOption` | - -### off - -取消事件监听 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.off.html) - -```tsx -(eventName: string, handler: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `string` | 事件名称 | -| handler | `TaroGeneral.EventCallback` | 事件监听函数 | - -### on - -监听事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.on.html) - -```tsx -(eventName: keyof OnEventName, handler: TaroGeneral.EventCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| eventName | `keyof OnEventName` | 事件名称 | -| handler | `TaroGeneral.EventCallback` | 事件监听函数 | - -### start - -开启缓存，仅在 mode 为 none 时生效，调用后缓存管理器的 state 会置为 1 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.start.html) - -```tsx -() => void -``` - -### stop - -关闭缓存，仅在 mode 为 none 时生效，调用后缓存管理器的 state 会置为 0 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.stop.html) - -```tsx -() => void -``` - -## 参数 - -### Mode - -| 参数 | 说明 | -| --- | --- | -| weakNetwork | 默认值，弱网/离线使用缓存返回 | -| always | 总是使用缓存返回 | -| none | 不开启，后续可手动开启/停止使用缓存返回 | - -### State - -| 参数 | 说明 | -| --- | --- | -| 0 | 不使用缓存返回 | -| 1 | 使用缓存返回 | -| 2 | 未知 | - -### DataSchema - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| type | `string` | 是 | 需要匹配的 data 对象的参数类型
string、number、boolean、null、object、any（表示任意类型），
同时支持数组模式（数组模式则在类型后面加 []，如 string[] 表示字符串数组） | -| value | string or Function or RegExp or DataRule[] | 否 | 需要匹配的 data 对象的参数值
当 type 为基本类型时，可以用 string/regexp 来匹配固定的值，
也可以通过 function 来确定值是否匹配，
如果传入的 type 是 object，那么表示需要嵌套匹配值是否正确，可以传入 Array | - -### DataRule - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| name | `string` | 需要匹配的参数名 | -| schema | DataSchema or DataSchema[] | | - -### RuleObject - -| 参数 | 类型 | 默认值 | 说明 | -| --- | --- | :---: | --- | -| id | `string` | | 规则 id，如果不填则会由基础库生成 | -| method | `string` | | 请求方法，可选值 GET/POST/PATCH/PUT/DELETE，如果为空则表示前面提到的所有方法都能被匹配到 | -| url | `any` | | uri 匹配规则，可参考规则字符串写法和正则写法 | -| maxAge | `number` | `7 * 24 * 60 * 60 * 1000` | 缓存有效时间，单位为 ms，不填则默认取缓存管理器全局的缓存有效时间 | -| dataSchema | `DataRule[]` | | 匹配请求参数 | - -### Rule - -### AddRuleOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| rule | `Rule` | 规则 | - -### AddRulesOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| rules | `Rule[]` | 规则列表 | - -### MatchOption - -| 参数 | 说明 | -| --- | --- | -| evt | request 事件对象 | - -### MatchResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ruleId | `string` | 命中的规则id | -| cacheId | `string` | 缓存id | -| data | `any` | 缓存内容，会带有 fromCache 标记，方便开发者区分内容是否来自缓存 | -| createTime | `number` | 缓存创建时间 | -| maxAge | `number` | 缓存有效时间 | - -### OnEventName - -| 参数 | 说明 | -| --- | --- | -| request | 发生 wx.request 请求，只在缓存管理器开启阶段会触发 | -| enterWeakNetwork | 进入弱网/离线状态 | -| exitWeakNetwork | 离开弱网/离线状态 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| CacheManager.addRule | ✔️ | | | | -| CacheManager.addRules | ✔️ | | | | -| CacheManager.clearCaches | ✔️ | | | | -| CacheManager.clearRules | ✔️ | | | | -| CacheManager.deleteCache | ✔️ | | | | -| CacheManager.deleteCaches | ✔️ | | | | -| CacheManager.deleteRule | ✔️ | | | | -| CacheManager.deleteRules | ✔️ | | | | -| CacheManager.match | ✔️ | | | | -| CacheManager.off | ✔️ | | | | -| CacheManager.on | ✔️ | | | | -| CacheManager.start | ✔️ | | | | -| CacheManager.stop | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/storage/cache-manager/createCacheManager.md b/versioned_docs/version-4.x/apis/storage/cache-manager/createCacheManager.md deleted file mode 100644 index 77bf046e54d1..000000000000 --- a/versioned_docs/version-4.x/apis/storage/cache-manager/createCacheManager.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.createCacheManager(option) -sidebar_label: createCacheManager ---- - -创建缓存管理器 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/wx.createCacheManager.html) - -## 类型 - -```tsx -(option: Option) => CacheManager -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Mode - -| 参数 | 说明 | -| --- | --- | -| weakNetwork | 弱网/离线使用缓存返回 | -| always | 总是使用缓存返回 | -| none | 不开启，后续可手动开启/停止使用缓存返回 | - -### Extra - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| apiList | `string[]` | 否 | 需要缓存的 wx api 接口，不传则表示支持缓存的接口全都做缓存处理。返回的如果是缓存数据，开发者可通过 fromCache 标记区分 | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| origin | `string` | 否 | 全局 origin | -| mode | `keyof Mode` | 否 | 缓存模式 | -| maxAge | `number` | 否 | 全局缓存有效时间，单位为毫秒，默认为 7 天，最长不超过 30 天 | -| extra | `Extra` | 否 | 额外的缓存处理 | diff --git a/versioned_docs/version-4.x/apis/storage/clearStorage.md b/versioned_docs/version-4.x/apis/storage/clearStorage.md deleted file mode 100644 index 7349387fb8be..000000000000 --- a/versioned_docs/version-4.x/apis/storage/clearStorage.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.clearStorage(option) -sidebar_label: clearStorage ---- - -清理本地数据缓存 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.clearStorage() -``` diff --git a/versioned_docs/version-4.x/apis/storage/clearStorageSync.md b/versioned_docs/version-4.x/apis/storage/clearStorageSync.md deleted file mode 100644 index 9d7ba528c3ed..000000000000 --- a/versioned_docs/version-4.x/apis/storage/clearStorageSync.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Taro.clearStorageSync() -sidebar_label: clearStorageSync ---- - -Taro.clearStorage 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorageSync.html) - -## 类型 - -```tsx -() => void -``` - -## 示例代码 - -```tsx -try { - Taro.clearStorageSync() -} catch(e) { -// Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/storage/createBufferURL.md b/versioned_docs/version-4.x/apis/storage/createBufferURL.md deleted file mode 100644 index ad5cf28ede07..000000000000 --- a/versioned_docs/version-4.x/apis/storage/createBufferURL.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.createBufferURL(buffer) -sidebar_label: createBufferURL ---- - -根据传入的 buffer 创建一个唯一的 URL 存在内存中 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.createBufferURL.html) - -## 类型 - -```tsx -(buffer: TypedArray | ArrayBuffer) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| buffer | TypedArray or ArrayBuffer | 需要存入内存的二进制数据 | diff --git a/versioned_docs/version-4.x/apis/storage/getStorage.md b/versioned_docs/version-4.x/apis/storage/getStorage.md deleted file mode 100644 index 48c8008d2eb5..000000000000 --- a/versioned_docs/version-4.x/apis/storage/getStorage.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.getStorage(option) -sidebar_label: getStorage ---- - -从本地缓存中异步获取指定 key 的内容 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorage.html) - -## 类型 - -```tsx -(option: Option) => Promise> -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `T` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| key | `string` | 是 | 本地缓存中指定的 key | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| data | `T` | key对应的内容 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.getStorage({ - key: 'key', - success: function (res) { - console.log(res.data) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/storage/getStorageInfo.md b/versioned_docs/version-4.x/apis/storage/getStorageInfo.md deleted file mode 100644 index 61653235c503..000000000000 --- a/versioned_docs/version-4.x/apis/storage/getStorageInfo.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Taro.getStorageInfo(option) -sidebar_label: getStorageInfo ---- - -异步获取当前storage的相关信息 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfo.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(option: SuccessCallbackOption) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackOption - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| currentSize | `number` | 当前占用的空间大小, 单位 KB | -| keys | `string[]` | 当前 storage 中所有的 key | -| limitSize | `number` | 限制的空间大小，单位 KB | - -## 示例代码 - -```tsx -Taro.getStorageInfo({ - success: function (res) { - console.log(res.keys) - console.log(res.currentSize) - console.log(res.limitSize) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/storage/getStorageInfoSync.md b/versioned_docs/version-4.x/apis/storage/getStorageInfoSync.md deleted file mode 100644 index 632982f2ac11..000000000000 --- a/versioned_docs/version-4.x/apis/storage/getStorageInfoSync.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Taro.getStorageInfoSync() -sidebar_label: getStorageInfoSync ---- - -Taro.getStorageInfo 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfoSync.html) - -## 类型 - -```tsx -() => Option -``` - -## 参数 - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| currentSize | `number` | 是 | 当前占用的空间大小, 单位 KB | -| keys | `string[]` | 是 | 当前 storage 中所有的 key | -| limitSize | `number` | 是 | 限制的空间大小，单位 KB | -| success | `boolean` | 否 | 是否执行成功
API 支持度: alipay | - -## 示例代码 - -```tsx -try { - const res = Taro.getStorageInfoSync() - console.log(res.keys) - console.log(res.currentSize) - console.log(res.limitSize) -} catch (e) { - // Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/storage/getStorageSync.md b/versioned_docs/version-4.x/apis/storage/getStorageSync.md deleted file mode 100644 index e66f09815ac9..000000000000 --- a/versioned_docs/version-4.x/apis/storage/getStorageSync.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.getStorageSync(key) -sidebar_label: getStorageSync ---- - -Taro.getStorage 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageSync.html) - -## 类型 - -```tsx -(key: string) => T -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `T` | 本地缓存中指定的 key | - -## 示例代码 - -```tsx -try { - var value = Taro.getStorageSync('key') - if (value) { - // Do something with return value - } -} catch (e) { - // Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/storage/removeStorage.md b/versioned_docs/version-4.x/apis/storage/removeStorage.md deleted file mode 100644 index d8b64d19d925..000000000000 --- a/versioned_docs/version-4.x/apis/storage/removeStorage.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.removeStorage(option) -sidebar_label: removeStorage ---- - -从本地缓存中移除指定 key - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| key | `string` | 是 | 本地缓存中指定的 key | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.removeStorage({ - key: 'key', - success: function (res) { - console.log(res) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/storage/removeStorageSync.md b/versioned_docs/version-4.x/apis/storage/removeStorageSync.md deleted file mode 100644 index 351e8d16da3f..000000000000 --- a/versioned_docs/version-4.x/apis/storage/removeStorageSync.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.removeStorageSync(key) -sidebar_label: removeStorageSync ---- - -Taro.removeStorage 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html) - -## 类型 - -```tsx -(key: string) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | 本地缓存中指定的 key | - -## 示例代码 - -```tsx -try { - Taro.removeStorageSync('key') -} catch (e) { - // Do something when catch error -} -``` diff --git a/versioned_docs/version-4.x/apis/storage/revokeBufferURL.md b/versioned_docs/version-4.x/apis/storage/revokeBufferURL.md deleted file mode 100644 index 8a8524631f6e..000000000000 --- a/versioned_docs/version-4.x/apis/storage/revokeBufferURL.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.revokeBufferURL(url) -sidebar_label: revokeBufferURL ---- - -根据 URL 销毁存在内存中的数据 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.revokeBufferURL.html) - -## 类型 - -```tsx -(url: string) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| url | `string` | 需要销毁的二进制数据 URL | diff --git a/versioned_docs/version-4.x/apis/storage/setStorage.md b/versioned_docs/version-4.x/apis/storage/setStorage.md deleted file mode 100644 index 5ebe3734c40c..000000000000 --- a/versioned_docs/version-4.x/apis/storage/setStorage.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Taro.setStorage(option) -sidebar_label: setStorage ---- - -将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorage.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| data | `any` | 是 | 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 | -| key | `string` | 是 | 本地缓存中指定的 key | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setStorage({ - key:"key", - data:"value" -}) -``` -```tsx -try { - Taro.setStorageSync('key', 'value') -} catch (e) { } -``` diff --git a/versioned_docs/version-4.x/apis/storage/setStorageSync.md b/versioned_docs/version-4.x/apis/storage/setStorageSync.md deleted file mode 100644 index 8a2562e49203..000000000000 --- a/versioned_docs/version-4.x/apis/storage/setStorageSync.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.setStorageSync(key, data) -sidebar_label: setStorageSync ---- - -Taro.setStorage 的同步版本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorageSync.html) - -## 类型 - -```tsx -(key: string, data: any) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| key | `string` | 本地缓存中指定的 key | -| data | `any` | 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 | - -## 示例代码 - -### 示例 1 - -```tsx -Taro.setStorage({ - key:"key", - data:"value" -}) -``` - -### 示例 2 - -```tsx -try { - Taro.setStorageSync('key', 'value') -} catch (e) { } -``` diff --git a/versioned_docs/version-4.x/apis/swan/setPageInfo.md b/versioned_docs/version-4.x/apis/swan/setPageInfo.md deleted file mode 100644 index 3be52d50ee07..000000000000 --- a/versioned_docs/version-4.x/apis/swan/setPageInfo.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Taro.setPageInfo(option) -sidebar_label: setPageInfo ---- - -百度智能小程序可接入百度搜索和百度 App，setPageInfo 负责为小程序设置各类页面基础信息，包括标题、关键字、页面描述以及图片信息、视频信息等。开发者为智能小程序设置完备的页面基础信息，有助于智能小程序在搜索引擎和信息流中得到更加有效的展示和分发。 - -支持情况： - -> [参考文档](https://smartprogram.baidu.com/docs/develop/api/open/swan-setPageInfo/) - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| title | `string` | 是 | 页面标题 | -| keywords | `string` | 是 | 页面关键字 | -| description | `string` | 是 | 页面描述信息 | -| releaseDate | `string` | 否 | 原始发布时间(年-月-日 时:分:秒 带有前导零） | -| articleTitle | `string` | 否 | 文章(内容)标题(适用于当前页面是图文、视频类的展示形式，文章标题需要准确标识当前文章的主要信息点；至少6个字，不可以全英文。) | -| image | string or string[] | 否 | 图片线上地址，用于信息流投放后的封面显示，最多3张，单图片最大2M；封面图建议尺寸：高>=210px & 宽>=375px；最小尺寸：高>=146px & 宽>=218px。多张图时，用数组表示 | -| video | `Video` | 否 | 视频信息，多个视频时，用数组表示 | -| visit | `Visit` | 否 | 浏览信息 | -| likes | `string` | 否 | 点赞量，若页面未统计可为空 | -| comments | `string` | 否 | 评论量，若页面未统计可为空 | -| collects | `string` | 否 | 收藏量，若页面未统计可为空 | -| shares | `string` | 否 | 分享量，若页面未统计可为空 | -| followers | `string` | 否 | 关注量，若页面未统计可为空 | -| success | `() => any` | 否 | 接口调用成功的回调函数 | -| fail | `(err: any) => any` | 否 | 接口调用失败的回调函数 | -| complete | `() => any` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### Video - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| url | `string` | 视频地址 | -| duration | `string` | 视频时长(单位为秒) | -| image | `string` | 视频封面图 | - -### Visit - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| pv | `string` | 否 | 页面的浏览量(不去重用户） | -| uv | `string` | 否 | 页面的点击量（去重用户） | -| sessionDuration | `string` | 否 | 页面的用户人均停留时长，以秒为单位。 | - -## 示例代码 - -```tsx -Taro.setPageInfo({ - title: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！-百度贴吧', - keywords: '百度,百度贴吧,好运中国年,60,晒元,宵节', - description: '晒元宵节活动红包，爱..昨天的百度APP元宵节活动中，共发出2亿现金红包、含151万个手气现金大奖和240辆红旗轿车，谁是好运锦鲤，快来分享！马上惊喜升级~摇中红包的锦鲤们即刻晒出红包金额截图，我们将会抽取660位好运锦鲤', - articleTitle: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！', - releaseDate: '2019-01-02 12:01:30', - image: [ - 'https://c.hiphotos.baidu.com/forum/w%3D480/sign=73c62dda83b1cb133e693d1bed5456da/f33725109313b07e8dee163d02d7912396dd8cfe.jpg', - 'https://hiphotos.baidu.com/fex/%70%69%63/item/43a7d933c895d143e7b745607ef082025baf07ab.jpg' - ], - video: [{ - url: 'https://www.baidu.com/mx/v12.mp4', - duration: '100', - image: 'https://smartprogram.baidu.com/docs/img/image-scaleToFill.png' - }], - visit: { - pv: '1000', - uv: '100', - sessionDuration: '130' - }, - likes: '75', - comments: '13', - collects: '23', - shares: '8', - followers: '35', - success: res => { - console.log('setPageInfo success'); - }, - fail: err => { - console.log('setPageInfo fail', err); - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/eventCenter.md b/versioned_docs/version-4.x/apis/taro.extend/eventCenter.md deleted file mode 100644 index 850fd9186fdc..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/eventCenter.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: eventCenter -sidebar_label: eventCenter ---- - -事件中心 - -支持情况： - -## 类型 - -```tsx -TaroGeneral.Events -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/getAppInfo.md b/versioned_docs/version-4.x/apis/taro.extend/getAppInfo.md deleted file mode 100644 index ce7e9376c00b..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getAppInfo.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Taro.getAppInfo() -sidebar_label: getAppInfo ---- - -小程序获取和 Taro 相关的 App 信息 - -支持情况： - -## 类型 - -```tsx -() => AppInfo -``` - -## 参数 - -### AppInfo - -应用信息 - -| 参数 | 类型 | -| --- | --- | -| platform | `string` | -| taroVersion | `string` | -| designWidth | number or ((size?: string or number) => number) | diff --git a/versioned_docs/version-4.x/apis/taro.extend/getCurrentInstance.md b/versioned_docs/version-4.x/apis/taro.extend/getCurrentInstance.md deleted file mode 100644 index 126008e2da0b..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getCurrentInstance.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Taro.getCurrentInstance() -sidebar_label: getCurrentInstance ---- - -获取当前页面实例 - -支持情况： - -## 类型 - -```tsx -() => Current -``` - -## 参数 - -### Current - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| app | `any` | 是 | | -| router | `any` | 是 | | -| page | `any` | 是 | | -| onReady | `string` | 是 | | -| onHide | `string` | 是 | | -| onShow | `string` | 是 | | -| preloadData | `Record` | 否 | | -| rnNavigationRef | `React.RefObject` | 否 | RN 私有对象navigationRef，用于使用底层接口控制路由 | diff --git a/versioned_docs/version-4.x/apis/taro.extend/getEnv.md b/versioned_docs/version-4.x/apis/taro.extend/getEnv.md deleted file mode 100644 index 9e0525d861cb..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getEnv.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Taro.getEnv() -sidebar_label: getEnv ---- - -获取环境变量 - -支持情况： - -## 类型 - -```tsx -() => TaroGeneral.ENV_TYPE -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/getEnvInfoSync.md b/versioned_docs/version-4.x/apis/taro.extend/getEnvInfoSync.md deleted file mode 100644 index 9381eac53d00..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getEnvInfoSync.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Taro.getEnvInfoSync() -sidebar_label: getEnvInfoSync ---- - -## 类型 - -```tsx -() => { microapp: { mpVersion: string; envType: string; appId: string; }; plugin: Record; common: { USER_DATA_PATH: string; location: string; launchFrom: string; schema: string; }; } -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/getRenderer.md b/versioned_docs/version-4.x/apis/taro.extend/getRenderer.md deleted file mode 100644 index fd3625b55ead..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getRenderer.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Taro.getRenderer() -sidebar_label: getRenderer ---- - -获取当前页面渲染引擎类型 - -支持情况： - -## 类型 - -```tsx -() => "webview" | "skyline" -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/getTabBar.md b/versioned_docs/version-4.x/apis/taro.extend/getTabBar.md deleted file mode 100644 index 1bb530ae6558..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/getTabBar.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.getTabBar(page) -sidebar_label: getTabBar ---- - -获取自定义 TabBar 对应的 React 或 Vue 组件实例 - -支持情况： - -## 类型 - -```tsx -(page: any) => T -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| page | `T` | 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
param: page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取 | diff --git a/versioned_docs/version-4.x/apis/taro.extend/initPxTransform.md b/versioned_docs/version-4.x/apis/taro.extend/initPxTransform.md deleted file mode 100644 index 177492090eff..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/initPxTransform.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.initPxTransform(config) -sidebar_label: initPxTransform ---- - -尺寸转换初始化 - -支持情况： - -## 类型 - -```tsx -(config: { baseFontSize?: number; deviceRatio?: TaroGeneral.TDeviceRatio; designWidth?: number | ((size?: string | number) => number); targetUnit?: string; unitPrecision?: number; }) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| config | { baseFontSize?: number; deviceRatio?: TaroGeneral.TDeviceRatio; designWidth?: number or ((size?: string or number) => number); targetUnit?: string; unitPrecision?: number; } | diff --git a/versioned_docs/version-4.x/apis/taro.extend/interceptorify.md b/versioned_docs/version-4.x/apis/taro.extend/interceptorify.md deleted file mode 100644 index 34fcf10a32f9..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/interceptorify.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: Taro.interceptorify(promiseifyApi) -sidebar_label: interceptorify ---- - -包裹 promiseify api 的洋葱圈模型 - -支持情况： - -## 类型 - -```tsx -(promiseifyApi: promiseifyApi) => Interceptorify -``` - -## 参数 - -### promiseifyApi - -```tsx -(requestParams: T) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| requestParams | `T` | - -### InterceptorifyChain - -| 参数 | 类型 | -| --- | --- | -| requestParams | `T` | -| proceed | `promiseifyApi` | - -### InterceptorifyInterceptor - -```tsx -(chain: InterceptorifyChain) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| chain | `InterceptorifyChain` | - -### Interceptorify - -#### request - -```tsx -(requestParams: T) => Promise -``` - -| 参数 | 类型 | -| --- | --- | -| requestParams | `T` | - -#### addInterceptor - -```tsx -(interceptor: InterceptorifyInterceptor) => void -``` - -| 参数 | 类型 | -| --- | --- | -| interceptor | `InterceptorifyInterceptor` | - -#### cleanInterceptors - -```tsx -() => void -``` - -## 示例代码 - -### 示例 1 - -```tsx -// 创建实例 -const modalInterceptorify = interceptorify(taro.showModal) -// 添加拦截器 -modalInterceptorify.addInterceptor(async function (chain) { - const res = await chain.proceed({ - ...chain.requestParams, - title: 'interceptor1' - }) - return res -}) -modalInterceptorify.addInterceptor(async function (chain) { - const res = await chain.proceed({ - ...chain.requestParams, - content: 'interceptor2' - }) - return res -}) -// 使用 -modalInterceptorify.request({}) -``` - -### 示例 2 - -```tsx -// 创建实例 -const fetchDataInterceptorify = interceptorify(taro.request) -// 添加拦截器 -fetchDataInterceptorify.addInterceptor(async function (chain) { - taro.showLoading({ - title: 'Loading...' - }) - const res = await chain.proceed(chain.requestParams) - taro.hideLoading() - return res -}) -fetchDataInterceptorify.addInterceptor(async function (chain) { - const params = chain.requestParams - const res = await chain.proceed({ - url: 'http://httpbin.org' + params.url, - }) - return res.data -}) -// 使用 -fetchDataInterceptorify.request({ - url: '/ip' -}).then((res) => { - // log my ip - console.log(res.origin) -}) -``` diff --git a/versioned_docs/version-4.x/apis/taro.extend/pxTransform.md b/versioned_docs/version-4.x/apis/taro.extend/pxTransform.md deleted file mode 100644 index 53445ac8172c..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/pxTransform.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.pxTransform(size) -sidebar_label: pxTransform ---- - -尺寸转换 - -支持情况： - -## 类型 - -```tsx -(size: number) => string -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| size | `number` | diff --git a/versioned_docs/version-4.x/apis/taro.extend/requirePlugin.md b/versioned_docs/version-4.x/apis/taro.extend/requirePlugin.md deleted file mode 100644 index 36a0c0e4d3a8..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/requirePlugin.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.requirePlugin(pluginName) -sidebar_label: requirePlugin ---- - -小程序引用插件 JS 接口 - -支持情况： - -## 类型 - -```tsx -(pluginName: string) => any -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| pluginName | `string` | diff --git a/versioned_docs/version-4.x/apis/taro.extend/setGlobalDataPlugin.md b/versioned_docs/version-4.x/apis/taro.extend/setGlobalDataPlugin.md deleted file mode 100644 index df85c2a742f6..000000000000 --- a/versioned_docs/version-4.x/apis/taro.extend/setGlobalDataPlugin.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: setGlobalDataPlugin -sidebar_label: setGlobalDataPlugin ---- - -Vue3 插件，用于设置 `getApp()` 中的全局变量 - -支持情况： - -## 类型 - -```tsx -Plugin -``` - -## 参数 - -### Plugin - -Vue3 插件，用于设置 `getApp()` 中的全局变量 - -#### install - -```tsx -(app: any, data: any) => void -``` - -## 示例代码 - -```js -// 使用插件 -const App = createApp(...) -App.use(setGlobalDataPlugin, { - xxx: 999 -}) -// 获取全局变量 -Taro.getApp().xxx -``` diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useAddToFavorites.md b/versioned_docs/version-4.x/apis/taro.hooks/useAddToFavorites.md deleted file mode 100644 index 195b1f5bd101..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useAddToFavorites.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useAddToFavorites(callback) -sidebar_label: useAddToFavorites ---- - -用户点击右上角菜单“收藏”按钮时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (payload: AddToFavoritesObject) => AddToFavoritesReturnObject) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(payload: AddToFavoritesObject) => AddToFavoritesReturnObject` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useDidHide.md b/versioned_docs/version-4.x/apis/taro.hooks/useDidHide.md deleted file mode 100644 index d05724ec904b..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useDidHide.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useDidHide(callback) -sidebar_label: useDidHide ---- - -页面隐藏时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useDidShow.md b/versioned_docs/version-4.x/apis/taro.hooks/useDidShow.md deleted file mode 100644 index 211fc066814a..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useDidShow.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useDidShow(callback) -sidebar_label: useDidShow ---- - -页面展示时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (options?: getLaunchOptionsSync.LaunchOptions) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(options?: getLaunchOptionsSync.LaunchOptions) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useError.md b/versioned_docs/version-4.x/apis/taro.hooks/useError.md deleted file mode 100644 index 25502aec5576..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useError.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useError(callback) -sidebar_label: useError ---- - -小程序发生脚本错误或 API 调用报错时触发的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (error: string) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(error: string) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useLaunch.md b/versioned_docs/version-4.x/apis/taro.hooks/useLaunch.md deleted file mode 100644 index e1fa0dcef1ef..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useLaunch.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useLaunch(callback) -sidebar_label: useLaunch ---- - -小程序初始化完成时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (options: getLaunchOptionsSync.LaunchOptions) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(options: getLaunchOptionsSync.LaunchOptions) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useLoad.md b/versioned_docs/version-4.x/apis/taro.hooks/useLoad.md deleted file mode 100644 index 53831051b44c..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useLoad.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useLoad(callback) -sidebar_label: useLoad ---- - -页面加载完成时的回调。 - -支持情况： - -## 类型 - -```tsx ->(callback: (param: T) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `T` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useOptionMenuClick.md b/versioned_docs/version-4.x/apis/taro.hooks/useOptionMenuClick.md deleted file mode 100644 index 329249af52f9..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useOptionMenuClick.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useOptionMenuClick(callback) -sidebar_label: useOptionMenuClick ---- - -导航栏的额外图标被点击时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/usePageNotFound.md b/versioned_docs/version-4.x/apis/taro.hooks/usePageNotFound.md deleted file mode 100644 index 6495de6909d5..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/usePageNotFound.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Taro.usePageNotFound(callback) -sidebar_label: usePageNotFound ---- - -小程序要打开的页面不存在时触发的回调。 - -支持情况： - -> H5: 多页面模式不支持该方法 - -## 类型 - -```tsx -(callback: (res: { [key: string]: any; path: string; query: Record; isEntryPage: boolean; }) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(res: { [key: string]: any; path: string; query: Record; isEntryPage: boolean; }) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/usePageScroll.md b/versioned_docs/version-4.x/apis/taro.hooks/usePageScroll.md deleted file mode 100644 index 85f8e918476f..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/usePageScroll.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.usePageScroll(callback) -sidebar_label: usePageScroll ---- - -页面滚动时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (payload: PageScrollObject) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(payload: PageScrollObject) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/usePullDownRefresh.md b/versioned_docs/version-4.x/apis/taro.hooks/usePullDownRefresh.md deleted file mode 100644 index 8485b43b4d34..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/usePullDownRefresh.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.usePullDownRefresh(callback) -sidebar_label: usePullDownRefresh ---- - -下拉刷新时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/usePullIntercept.md b/versioned_docs/version-4.x/apis/taro.hooks/usePullIntercept.md deleted file mode 100644 index f85c965969f0..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/usePullIntercept.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.usePullIntercept(callback) -sidebar_label: usePullIntercept ---- - -下拉中断时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useReachBottom.md b/versioned_docs/version-4.x/apis/taro.hooks/useReachBottom.md deleted file mode 100644 index c603995244e7..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useReachBottom.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useReachBottom(callback) -sidebar_label: useReachBottom ---- - -上拉触底时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useReady.md b/versioned_docs/version-4.x/apis/taro.hooks/useReady.md deleted file mode 100644 index 4eba419ada5d..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useReady.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Taro.useReady(callback) -sidebar_label: useReady ---- - -页面初次渲染完成的回调。 -此时页面已经准备妥当，可以和视图层进行交互。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useResize.md b/versioned_docs/version-4.x/apis/taro.hooks/useResize.md deleted file mode 100644 index c0ec05209de3..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useResize.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useResize(callback) -sidebar_label: useResize ---- - -页面尺寸改变时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (payload: PageResizeObject) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(payload: PageResizeObject) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useRouter.md b/versioned_docs/version-4.x/apis/taro.hooks/useRouter.md deleted file mode 100644 index de41f6dbcd58..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useRouter.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useRouter(dynamic) -sidebar_label: useRouter ---- - -获取当前路由参数。 - -支持情况： - -## 类型 - -```tsx -> = Partial>>(dynamic?: boolean) => RouterInfo -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| dynamic | `TParams` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useSaveExitState.md b/versioned_docs/version-4.x/apis/taro.hooks/useSaveExitState.md deleted file mode 100644 index 63061946c021..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useSaveExitState.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useSaveExitState(callback) -sidebar_label: useSaveExitState ---- - -页面销毁前保留状态回调 - -支持情况： - -## 类型 - -```tsx -(callback: () => { data: Record; expireTimeStamp?: number; }) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => { data: Record; expireTimeStamp?: number; }` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useShareAppMessage.md b/versioned_docs/version-4.x/apis/taro.hooks/useShareAppMessage.md deleted file mode 100644 index 65a9b47ef89e..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useShareAppMessage.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useShareAppMessage(callback) -sidebar_label: useShareAppMessage ---- - -页面转发时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (payload: ShareAppMessageObject) => ShareAppMessageReturn) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(payload: ShareAppMessageObject) => ShareAppMessageReturn` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useShareTimeline.md b/versioned_docs/version-4.x/apis/taro.hooks/useShareTimeline.md deleted file mode 100644 index 3d4cd9c5d6a3..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useShareTimeline.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useShareTimeline(callback) -sidebar_label: useShareTimeline ---- - -用户点击右上角菜单“分享到朋友圈”按钮时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => ShareTimelineReturnObject) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => ShareTimelineReturnObject` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useTabItemTap.md b/versioned_docs/version-4.x/apis/taro.hooks/useTabItemTap.md deleted file mode 100644 index 656d24e1021b..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useTabItemTap.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useTabItemTap(callback) -sidebar_label: useTabItemTap ---- - -当前是 tab 页时，tab 被点击时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: (payload: TabItemTapObject) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(payload: TabItemTapObject) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useTitleClick.md b/versioned_docs/version-4.x/apis/taro.hooks/useTitleClick.md deleted file mode 100644 index e5e68951cc1e..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useTitleClick.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useTitleClick(callback) -sidebar_label: useTitleClick ---- - -导航栏的标题被点击时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useUnhandledRejection.md b/versioned_docs/version-4.x/apis/taro.hooks/useUnhandledRejection.md deleted file mode 100644 index 9ec904a41974..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useUnhandledRejection.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useUnhandledRejection(callback) -sidebar_label: useUnhandledRejection ---- - -小程序有未处理的 Promise reject 时触发。也可以使用 Taro.onUnhandledRejection 绑定监听。 - -支持情况： - -## 类型 - -```tsx -(callback: (error: { reason: Error; promise: Promise; }) => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(error: { reason: Error; promise: Promise; }) => void` | diff --git a/versioned_docs/version-4.x/apis/taro.hooks/useUnload.md b/versioned_docs/version-4.x/apis/taro.hooks/useUnload.md deleted file mode 100644 index 5c39d64cd8c2..000000000000 --- a/versioned_docs/version-4.x/apis/taro.hooks/useUnload.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Taro.useUnload(callback) -sidebar_label: useUnload ---- - -页面卸载时的回调。 - -支持情况： - -## 类型 - -```tsx -(callback: () => void) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `() => void` | diff --git a/versioned_docs/version-4.x/apis/ui/animation/Animation.md b/versioned_docs/version-4.x/apis/ui/animation/Animation.md deleted file mode 100644 index 4a874956e610..000000000000 --- a/versioned_docs/version-4.x/apis/ui/animation/Animation.md +++ /dev/null @@ -1,577 +0,0 @@ ---- -title: Animation -sidebar_label: Animation ---- - -动画对象 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.html) - -## 方法 - -### export - -导出动画队列。**export 方法每次调用后会清掉之前的动画操作**。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.export.html) - -```tsx -() => { actions: TaroGeneral.IAnyObject[]; } -``` - -### step - -表示一组动画完成。可以在一组动画中调用任意多个动画方法，一组动画中的所有动画会同时开始，一组动画完成后才会进行下一组动画。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.step.html) - -```tsx -(option?: StepOption) => Animation -``` - -| 参数 | 类型 | -| --- | --- | -| option | `StepOption` | - -### matrix - -同 [transform-function matrix](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/matrix) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.matrix.html) - -```tsx -(a: number, b: number, c: number, d: number, tx: number, ty: number) => Animation -``` - -| 参数 | 类型 | -| --- | --- | -| a | `number` | -| b | `number` | -| c | `number` | -| d | `number` | -| tx | `number` | -| ty | `number` | - -### matrix3d - -同 [transform-function matrix3d](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/matrix3d) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.matrix3d.html) - -```tsx -(a1: number, b1: number, c1: number, d1: number, a2: number, b2: number, c2: number, d2: number, a3: number, b3: number, c3: number, d3: number, a4: number, b4: number, c4: number, d4: number) => Animation -``` - -| 参数 | 类型 | -| --- | --- | -| a1 | `number` | -| b1 | `number` | -| c1 | `number` | -| d1 | `number` | -| a2 | `number` | -| b2 | `number` | -| c2 | `number` | -| d2 | `number` | -| a3 | `number` | -| b3 | `number` | -| c3 | `number` | -| d3 | `number` | -| a4 | `number` | -| b4 | `number` | -| c4 | `number` | -| d4 | `number` | - -### rotate - -从原点顺时针旋转一个角度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.rotate.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 旋转的角度。范围 [-180, 180] | - -### rotate3d - -从 固定 轴顺时针旋转一个角度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.rotate3d.html) - -```tsx -(x: number, y?: number, z?: number, angle?: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| x | `number` | 旋转轴的 x 坐标 | -| y | `number` | 旋转轴的 y 坐标 | -| z | `number` | 旋转轴的 z 坐标 | -| angle | `number` | 旋转的角度。范围 [-180, 180] | - -### rotateX - -从 X 轴顺时针旋转一个角度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.rotateX.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 旋转的角度。范围 [-180, 180] | - -### rotateY - -从 Y 轴顺时针旋转一个角度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.rotateY.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 旋转的角度。范围 [-180, 180] | - -### rotateZ - -从 Z 轴顺时针旋转一个角度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.rotateZ.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 旋转的角度。范围 [-180, 180] | - -### scale - -缩放 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.scale.html) - -```tsx -(sx: number, sy?: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sx | `number` | 当仅有 sx 参数时，表示在 X 轴、Y 轴同时缩放sx倍数 | -| sy | `number` | 在 Y 轴缩放 sy 倍数 | - -### scale3d - -缩放 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.scale3d.html) - -```tsx -(sx: number, sy: number, sz: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| sx | `number` | x 轴的缩放倍数 | -| sy | `number` | y 轴的缩放倍数 | -| sz | `number` | z 轴的缩放倍数 | - -### scaleX - -缩放 X 轴 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.scaleX.html) - -```tsx -(scale: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scale | `number` | X 轴的缩放倍数 | - -### scaleY - -缩放 Y 轴 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.scaleY.html) - -```tsx -(scale: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scale | `number` | Y 轴的缩放倍数 | - -### scaleZ - -缩放 Z 轴 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.scaleZ.html) - -```tsx -(scale: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scale | `number` | Z 轴的缩放倍数 | - -### skew - -对 X、Y 轴坐标进行倾斜 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.skew.html) - -```tsx -(ax: number, ay: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| ax | `number` | 对 X 轴坐标倾斜的角度，范围 [-180, 180] | -| ay | `number` | 对 Y 轴坐标倾斜的角度，范围 [-180, 180] | - -### skewX - -对 X 轴坐标进行倾斜 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.skewX.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 倾斜的角度，范围 [-180, 180] | - -### skewY - -对 Y 轴坐标进行倾斜 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.skewY.html) - -```tsx -(angle: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| angle | `number` | 倾斜的角度，范围 [-180, 180] | - -### translate - -平移变换 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.translate.html) - -```tsx -(tx?: number, ty?: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tx | `number` | 当仅有该参数时表示在 X 轴偏移 tx，单位 px | -| ty | `number` | 在 Y 轴平移的距离，单位为 px | - -### translate3d - -对 xyz 坐标进行平移变换 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.translate3d.html) - -```tsx -(tx?: number, ty?: number, tz?: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tx | `number` | 在 X 轴平移的距离，单位为 px | -| ty | `number` | 在 Y 轴平移的距离，单位为 px | -| tz | `number` | 在 Z 轴平移的距离，单位为 px | - -### translateX - -对 X 轴平移 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.translateX.html) - -```tsx -(translation: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| translation | `number` | 在 X 轴平移的距离，单位为 px | - -### translateY - -对 Y 轴平移 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.translateY.html) - -```tsx -(translation: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| translation | `number` | 在 Y 轴平移的距离，单位为 px | - -### translateZ - -对 Z 轴平移 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.translateZ.html) - -```tsx -(translation: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| translation | `number` | 在 Z 轴平移的距离，单位为 px | - -### opacity - -设置透明度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.opacity.html) - -```tsx -(value: number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | `number` | 透明度，范围 0-1 | - -### backgroundColor - -设置背景色 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.backgroundColor.html) - -```tsx -(value: string) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | `string` | 颜色值 | - -### width - -设置宽度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.width.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -### height - -设置高度 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.height.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -### left - -设置 left 值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.left.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -### right - -设置 right 值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.right.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -### top - -设置 top 值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.top.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -### bottom - -设置 bottom 值 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.bottom.html) - -```tsx -(value: string | number) => Animation -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| value | string or number | 长度值，如果传入 number 则默认使用 px，可传入其他自定义单位的长度值 | - -## 参数 - -### StepOption - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| delay | `number` | 否 | 动画延迟时间，单位 ms | -| duration | `number` | 否 | 动画持续时间，单位 ms | -| timingFunction | `keyof TimingFunction` | 否 | 动画的效果 | -| transformOrigin | `string` | 否 | | - -### TimingFunction - -| 参数 | 说明 | -| --- | --- | -| linear | 动画从头到尾的速度是相同的 | -| ease | 动画以低速开始，然后加快，在结束前变慢 | -| ease-in | 动画以低速开始 | -| ease-in-out | 动画以低速开始和结束 | -| ease-out | 动画以低速结束 | -| step-start | 动画第一帧就跳至结束状态直到结束 | -| step-end | 动画一直保持开始状态，最后一帧跳到结束状态 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| Animation | ✔️ | ✔️ | ✔️ | | | -| Animation.export | ✔️ | ✔️ | ✔️ | | | -| Animation.step | ✔️ | ✔️ | ✔️ | | | -| Animation.matrix | ✔️ | ✔️ | ✔️ | | | -| Animation.matrix3d | ✔️ | ✔️ | ✔️ | | | -| Animation.rotate | ✔️ | ✔️ | ✔️ | | | -| Animation.rotate3d | ✔️ | ✔️ | ✔️ | | | -| Animation.rotateX | ✔️ | ✔️ | ✔️ | | | -| Animation.rotateY | ✔️ | ✔️ | ✔️ | | | -| Animation.rotateZ | ✔️ | ✔️ | ✔️ | | | -| Animation.scale | ✔️ | ✔️ | ✔️ | | | -| Animation.scale3d | ✔️ | ✔️ | ✔️ | | | -| Animation.scaleX | ✔️ | ✔️ | ✔️ | | | -| Animation.scaleY | ✔️ | ✔️ | ✔️ | | | -| Animation.scaleZ | ✔️ | ✔️ | ✔️ | | | -| Animation.skew | ✔️ | ✔️ | ✔️ | | | -| Animation.skewX | ✔️ | ✔️ | ✔️ | | | -| Animation.skewY | ✔️ | ✔️ | ✔️ | | | -| Animation.translate | ✔️ | ✔️ | ✔️ | | | -| Animation.translate3d | ✔️ | ✔️ | ✔️ | | | -| Animation.translateX | ✔️ | ✔️ | ✔️ | | | -| Animation.translateY | ✔️ | ✔️ | ✔️ | | | -| Animation.translateZ | ✔️ | ✔️ | ✔️ | | | -| Animation.opacity | ✔️ | ✔️ | ✔️ | | | -| Animation.backgroundColor | ✔️ | ✔️ | ✔️ | | | -| Animation.width | ✔️ | ✔️ | ✔️ | | | -| Animation.height | ✔️ | ✔️ | ✔️ | | | -| Animation.left | ✔️ | ✔️ | ✔️ | | | -| Animation.right | ✔️ | ✔️ | ✔️ | | | -| Animation.top | ✔️ | ✔️ | ✔️ | | | -| Animation.bottom | ✔️ | ✔️ | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/ui/animation/createAnimation.md b/versioned_docs/version-4.x/apis/ui/animation/createAnimation.md deleted file mode 100644 index 47ac8dc59aeb..000000000000 --- a/versioned_docs/version-4.x/apis/ui/animation/createAnimation.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Taro.createAnimation(option) -sidebar_label: createAnimation ---- - -创建一个动画实例 [animation](../Animation)。调用实例的方法来描述动画。最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/wx.createAnimation.html) - -## 类型 - -```tsx -(option: Option) => Animation -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| duration | `number` | | 否 | 动画持续时间，单位 ms | -| timingFunction | `keyof TimingFunction` | | 否 | 动画的效果 | -| delay | `number` | `0` | 否 | 动画延迟时间，单位 ms | -| transformOrigin | `string` | `"50% 50% 0"` | 否 | | -| unit | `string` | | 否 | 单位
API 支持度: h5 | - -### TimingFunction - -| 参数 | 说明 | -| --- | --- | -| linear | 动画从头到尾的速度是相同的 | -| ease | 动画以低速开始，然后加快，在结束前变慢 | -| ease-in | 动画以低速开始 | -| ease-in-out | 动画以低速开始和结束 | -| ease-out | 动画以低速结束 | -| step-start | 动画第一帧就跳至结束状态直到结束 | -| step-end | 动画一直保持开始状态，最后一帧跳到结束状态 | - -## 示例代码 - -```tsx -var animation = Taro.createAnimation({ - transformOrigin: "50% 50%", - duration: 1000, - timingFunction: "ease", - delay: 0 -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/background/setBackgroundColor.md b/versioned_docs/version-4.x/apis/ui/background/setBackgroundColor.md deleted file mode 100644 index fd03bd30666b..000000000000 --- a/versioned_docs/version-4.x/apis/ui/background/setBackgroundColor.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.setBackgroundColor(option) -sidebar_label: setBackgroundColor ---- - -动态设置窗口的背景色 - -支持情况： - -> React Native: 仅 Android - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundColor.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| backgroundColor | `string` | 否 | 窗口的背景色，必须为十六进制颜色值 | -| backgroundColorBottom | `string` | 否 | 底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持 | -| backgroundColorTop | `string` | 否 | 顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setBackgroundColor({ - backgroundColor: '#ffffff', // 窗口的背景色为白色 -}) -Taro.setBackgroundColor({ - backgroundColorTop: '#ffffff', // 顶部窗口的背景色为白色 - backgroundColorBottom: '#ffffff', // 底部窗口的背景色为白色 -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/background/setBackgroundTextStyle.md b/versioned_docs/version-4.x/apis/ui/background/setBackgroundTextStyle.md deleted file mode 100644 index 86d96380862a..000000000000 --- a/versioned_docs/version-4.x/apis/ui/background/setBackgroundTextStyle.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.setBackgroundTextStyle(option) -sidebar_label: setBackgroundTextStyle ---- - -动态设置下拉背景字体、loading 图的样式 - -支持情况： - -> React Native: 仅 iOS - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundTextStyle.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| textStyle | "dark" or "light" | 是 | 下拉背景字体、loading 图的样式。

可选值：
- 'dark': dark 样式;
- 'light': light 样式; | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setBackgroundTextStyle({ - textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/custom-component/nextTick.md b/versioned_docs/version-4.x/apis/ui/custom-component/nextTick.md deleted file mode 100644 index 291145e0f6d9..000000000000 --- a/versioned_docs/version-4.x/apis/ui/custom-component/nextTick.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Taro.nextTick(callback) -sidebar_label: nextTick ---- - -延迟一部分操作到下一个时间片再执行。（类似于 setTimeout） - -**说明** -因为自定义组件中的 setData 和 triggerEvent 等接口本身是同步的操作，当这几个接口被连续调用时，都是在一个同步流程中执行完的，因此若逻辑不当可能会导致出错。 -一个极端的案例：当父组件的 setData 引发了子组件的 triggerEvent，进而使得父组件又进行了一次 setData，期间有通过 wx:if 语句对子组件进行卸载，就有可能引发奇怪的错误，所以对于不需要在一个同步流程内完成的逻辑，可以使用此接口延迟到下一个时间片再执行。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/custom-component/wx.nextTick.html) - -## 类型 - -```tsx -(callback: (...args: any[]) => any) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| callback | `(...args: any[]) => any` | - -## 示例代码 - -```tsx -this.setData({ number: 1 }) // 直接在当前同步流程中执行 -Taro.nextTick(() => { - this.setData({ number: 3 }) // 在当前同步流程结束后，下一个时间片执行 -}) -this.setData({ number: 2 }) // 直接在当前同步流程中执行 -``` diff --git a/versioned_docs/version-4.x/apis/ui/fonts/loadFontFace.md b/versioned_docs/version-4.x/apis/ui/fonts/loadFontFace.md deleted file mode 100644 index e9276afea6f8..000000000000 --- a/versioned_docs/version-4.x/apis/ui/fonts/loadFontFace.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Taro.loadFontFace(option) -sidebar_label: loadFontFace ---- - -动态加载网络字体。文件地址需为下载类型。iOS 仅支持 https 格式文件地址。 - -注意： -1. 字体文件返回的 context-type 参考 [font](https://www.iana.org/assignments/media-types/media-types.xhtml#font)，格式不正确时会解析失败。 -2. 字体链接必须是https（ios不支持http) -3. 字体链接必须是同源下的，或开启了cors支持，小程序的域名是`servicewechat.com` -4. canvas等原生组件不支持使用接口添加的字体 -5. 工具里提示 Failed to load font 可以忽略 - -支持情况： - -> 支付宝小程序: source 地址格式为 `url('https://...')`，而不是单纯 URL 地址 -> -> H5: 不支持 global (默认全局加载) - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| global | `boolean` | `false` | 否 | 是否全局生效 | -| family | `string` | | 是 | 定义的字体名称 | -| source | `string` | | 是 | 字体资源的地址。建议格式为 TTF 和 WOFF，WOFF2 在低版本的 iOS 上会不兼容。 | -| desc | `DescOption` | | 否 | 可选的字体描述符 | -| success | `(res: CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | -| fail | `(res: CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| complete | `(res: CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -### CallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| status | `string` | 加载字体结果 | - -### DescOption - -可选的字体描述符 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| ascentOverride | `string` | 否 |
API 支持度: h5 | -| descentOverride | `string` | 否 |
API 支持度: h5 | -| featureSettings | `string` | 否 |
API 支持度: h5 | -| lineGapOverride | `string` | 否 |
API 支持度: h5 | -| stretch | `string` | 否 |
API 支持度: h5 | -| style | `string` | 否 | 字体样式，可选值为 normal / italic / oblique | -| unicodeRange | `string` | 否 |
API 支持度: h5 | -| variant | `string` | 否 | 设置小型大写字母的字体显示文本，可选值为 normal / small-caps / inherit | -| variationSettings | `string` | 否 |
API 支持度: h5 | -| weight | `string` | 否 | 字体粗细，可选值为 normal / bold / 100 / 200../ 900 | - -## 示例代码 - -```tsx -Taro.loadFontFace({ - family: 'Bitstream Vera Serif Bold', - source: 'url("https://sungd.github.io/Pacifico.ttf")', - success: console.log -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/interaction/disableAlertBeforeUnload.md b/versioned_docs/version-4.x/apis/ui/interaction/disableAlertBeforeUnload.md deleted file mode 100644 index e7987fccf8c1..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/disableAlertBeforeUnload.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.disableAlertBeforeUnload(option) -sidebar_label: disableAlertBeforeUnload ---- - -关闭小程序页面返回询问对话框 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.disableAlertBeforeUnload.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/interaction/enableAlertBeforeUnload.md b/versioned_docs/version-4.x/apis/ui/interaction/enableAlertBeforeUnload.md deleted file mode 100644 index bae96e4d406c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/enableAlertBeforeUnload.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Taro.enableAlertBeforeUnload(option) -sidebar_label: enableAlertBeforeUnload ---- - -## 类型 - -```tsx -(option: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| message | `string` | 是 | 询问对话框内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/interaction/hideLoading.md b/versioned_docs/version-4.x/apis/ui/interaction/hideLoading.md deleted file mode 100644 index 7da00ee445a6..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/hideLoading.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.hideLoading(option) -sidebar_label: hideLoading ---- - -隐藏 loading 提示框 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideLoading.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| noConflict | `boolean` | `false` | 否 | 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.showLoading({ - title: '加载中', -}) -setTimeout(function (){ - Taro.hideLoading() -},2000) -``` diff --git a/versioned_docs/version-4.x/apis/ui/interaction/hideToast.md b/versioned_docs/version-4.x/apis/ui/interaction/hideToast.md deleted file mode 100644 index e2d429fe1e93..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/hideToast.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.hideToast(option) -sidebar_label: hideToast ---- - -隐藏消息提示框 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideToast.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 默认值 | 必填 | 说明 | -| --- | --- | :---: | :---: | --- | -| noConflict | `boolean` | `false` | 否 | 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/interaction/showActionSheet.md b/versioned_docs/version-4.x/apis/ui/interaction/showActionSheet.md deleted file mode 100644 index 7fa1c622be02..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/showActionSheet.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Taro.showActionSheet(option) -sidebar_label: showActionSheet ---- - -显示操作菜单 - -**注意** -- Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"； -- Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showActionSheet.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| alertText | `string` | 否 | 警示文案 | -| itemList | `string[]` | 是 | 按钮的文字数组，数组长度最大为 6 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| itemColor | `string` | 否 | 按钮的文字颜色 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| tapIndex | `number` | 用户点击的按钮序号，从上到下的顺序，从0开始 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.showActionSheet({ - itemList: ['A', 'B', 'C'], - success: function (res) { - console.log(res.tapIndex) - }, - fail: function (res) { - console.log(res.errMsg) - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/interaction/showLoading.md b/versioned_docs/version-4.x/apis/ui/interaction/showLoading.md deleted file mode 100644 index d922d7c055fb..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/showLoading.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.showLoading(option) -sidebar_label: showLoading ---- - -显示 loading 提示框。需主动调用 Taro.hideLoading 才能关闭提示框 - -**注意** -- Taro.showLoading 和 Taro.showToast 同时只能显示一个 -- Taro.showLoading 应与 Taro.hideLoading 配对使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| title | `string` | 是 | 提示的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| mask | `boolean` | 否 | 是否显示透明蒙层，防止触摸穿透 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.showLoading({ - title: '加载中', -}) -setTimeout(function () { - Taro.hideLoading() -}, 2000) -``` diff --git a/versioned_docs/version-4.x/apis/ui/interaction/showModal.md b/versioned_docs/version-4.x/apis/ui/interaction/showModal.md deleted file mode 100644 index add1611b78a0..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/showModal.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Taro.showModal(option) -sidebar_label: showModal ---- - -显示模态对话框 -**注意** -- Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"； -- Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showModal.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| cancelColor | `string` | 否 | 取消按钮的文字颜色，必须是 16 进制格式的颜色字符串 | -| cancelText | `string` | 否 | 取消按钮的文字，最多 4 个字符 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| confirmColor | `string` | 否 | 确认按钮的文字颜色，必须是 16 进制格式的颜色字符串 | -| confirmText | `string` | 否 | 确认按钮的文字，最多 4 个字符 | -| content | `string` | 否 | 提示的内容 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| showCancel | `boolean` | 否 | 是否显示取消按钮 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| title | `string` | 否 | 提示的标题 | - -### SuccessCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| cancel | `boolean` | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） | -| confirm | `boolean` | 为 true 时，表示用户点击了确定按钮 | -| errMsg | `string` | 调用结果 | - -## 示例代码 - -```tsx -Taro.showModal({ - title: '提示', - content: '这是一个模态弹窗', - success: function (res) { - if (res.confirm) { - console.log('用户点击确定') - } else if (res.cancel) { - console.log('用户点击取消') - } - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/interaction/showToast.md b/versioned_docs/version-4.x/apis/ui/interaction/showToast.md deleted file mode 100644 index 8e8d9d45bf80..000000000000 --- a/versioned_docs/version-4.x/apis/ui/interaction/showToast.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Taro.showToast(option) -sidebar_label: showToast ---- - -显示消息提示框 - -**注意** -- Taro.showLoading 和 Taro.showToast 同时只能显示一个 -- Taro.showToast 应与 Taro.hideToast 配对使用 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showToast.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| title | `string` | 是 | 提示的内容 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| duration | `number` | 否 | 提示的延迟时间 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| icon | "success" or "error" or "loading" or "none" | 否 | 图标

可选值：
- 'success': 显示成功图标，此时 title 文本最多显示 7 个汉字长度;
- 'error': 显示失败图标，此时 title 文本最多显示 7 个汉字长度;
- 'loading': 显示加载图标，此时 title 文本最多显示 7 个汉字长度;
- 'none': 不显示图标，此时 title 文本最多可显示两行 | -| image | `string` | 否 | 自定义图标的本地路径，image 的优先级高于 icon | -| mask | `boolean` | 否 | 是否显示透明蒙层，防止触摸穿透 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.showToast({ - title: '成功', - icon: 'success', - duration: 2000 -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/menu/getMenuButtonBoundingClientRect.md b/versioned_docs/version-4.x/apis/ui/menu/getMenuButtonBoundingClientRect.md deleted file mode 100644 index 8209d056e184..000000000000 --- a/versioned_docs/version-4.x/apis/ui/menu/getMenuButtonBoundingClientRect.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.getMenuButtonBoundingClientRect() -sidebar_label: getMenuButtonBoundingClientRect ---- - -获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html) - -## 类型 - -```tsx -() => Rect -``` - -## 参数 - -### Rect - -菜单按钮的布局位置信息 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bottom | `number` | 下边界坐标，单位：px | -| height | `number` | 高度，单位：px | -| left | `number` | 左边界坐标，单位：px | -| right | `number` | 右边界坐标，单位：px | -| top | `number` | 上边界坐标，单位：px | -| width | `number` | 宽度，单位：px | diff --git a/versioned_docs/version-4.x/apis/ui/navigation-bar/hideHomeButton.md b/versioned_docs/version-4.x/apis/ui/navigation-bar/hideHomeButton.md deleted file mode 100644 index f76a23ddd11c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/navigation-bar/hideHomeButton.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.hideHomeButton(option) -sidebar_label: hideHomeButton ---- - -隐藏返回首页按钮。微信7.0.7版本起，当用户打开的小程序最底层页面是非首页时，默认展示“返回首页”按钮，开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideHomeButton.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/navigation-bar/hideNavigationBarLoading.md b/versioned_docs/version-4.x/apis/ui/navigation-bar/hideNavigationBarLoading.md deleted file mode 100644 index 2c55548c93de..000000000000 --- a/versioned_docs/version-4.x/apis/ui/navigation-bar/hideNavigationBarLoading.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.hideNavigationBarLoading(option) -sidebar_label: hideNavigationBarLoading ---- - -在当前页面隐藏导航条加载动画 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideNavigationBarLoading.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarColor.md b/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarColor.md deleted file mode 100644 index bf81b742e56c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarColor.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Taro.setNavigationBarColor(option) -sidebar_label: setNavigationBarColor ---- - -设置页面导航条颜色 - -支持情况： - -> H5: 不支持 animation 参数 -> -> React Native: 不支持 animation 参数 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarColor.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| backgroundColor | `string` | 是 | 背景颜色值，有效值为十六进制颜色 | -| frontColor | `string` | 是 | 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 | -| animation | `AnimationOption` | 否 | 动画效果 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -### AnimationOption - -动画效果 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| duration | `number` | 否 | 动画变化时间，单位 ms | -| timingFunc | "linear" or "easeIn" or "easeOut" or "easeInOut" | 否 | 动画变化方式

可选值：
- 'linear': 动画从头到尾的速度是相同的;
- 'easeIn': 动画以低速开始;
- 'easeOut': 动画以低速结束;
- 'easeInOut': 动画以低速开始和结束; | - -## 示例代码 - -```tsx -Taro.setNavigationBarColor({ - frontColor: '#ffffff', - backgroundColor: '#ff0000', - animation: { - duration: 400, - timingFunc: 'easeIn' - } -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarTitle.md b/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarTitle.md deleted file mode 100644 index 772bb9135cac..000000000000 --- a/versioned_docs/version-4.x/apis/ui/navigation-bar/setNavigationBarTitle.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Taro.setNavigationBarTitle(option) -sidebar_label: setNavigationBarTitle ---- - -动态设置当前页面的标题 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarTitle.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| title | `string` | 是 | 页面标题 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setNavigationBarTitle({ - title: '当前页面' -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/navigation-bar/showNavigationBarLoading.md b/versioned_docs/version-4.x/apis/ui/navigation-bar/showNavigationBarLoading.md deleted file mode 100644 index f554e6107d4c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/navigation-bar/showNavigationBarLoading.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Taro.showNavigationBarLoading(option) -sidebar_label: showNavigationBarLoading ---- - -在当前页面显示导航条加载动画 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.showNavigationBarLoading.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/pull-down-refresh/startPullDownRefresh.md b/versioned_docs/version-4.x/apis/ui/pull-down-refresh/startPullDownRefresh.md deleted file mode 100644 index 1237eb90f16c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/pull-down-refresh/startPullDownRefresh.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.startPullDownRefresh(option) -sidebar_label: startPullDownRefresh ---- - -开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 - -支持情况： - -> React Native: 无动画效果 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.startPullDownRefresh.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.startPullDownRefresh() -``` diff --git a/versioned_docs/version-4.x/apis/ui/pull-down-refresh/stopPullDownRefresh.md b/versioned_docs/version-4.x/apis/ui/pull-down-refresh/stopPullDownRefresh.md deleted file mode 100644 index 643fab836e10..000000000000 --- a/versioned_docs/version-4.x/apis/ui/pull-down-refresh/stopPullDownRefresh.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Taro.stopPullDownRefresh(option) -sidebar_label: stopPullDownRefresh ---- - -停止当前页面下拉刷新。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.stopPullDownRefresh.html) - -## 类型 - -```tsx -(option?: Option) => void -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -onPullDownRefresh: function (){ - Taro.stopPullDownRefresh() -} -``` diff --git a/versioned_docs/version-4.x/apis/ui/scroll/ScrollViewContext.md b/versioned_docs/version-4.x/apis/ui/scroll/ScrollViewContext.md deleted file mode 100644 index 9daf662d7394..000000000000 --- a/versioned_docs/version-4.x/apis/ui/scroll/ScrollViewContext.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: ScrollViewContext -sidebar_label: ScrollViewContext ---- - -增强 ScrollView 实例，可通过 [Taro.createSelectorQuery](/docs/apis/wxml/createSelectorQuery) 的 [NodesRef.node](/docs/apis/wxml/NodesRef#node) 方法获取。 仅在 `scroll-view` 组件开启 `enhanced` 属性后生效。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.html) - -## 方法 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scrollEnabled | `boolean` | 滚动开关 | -| bounces | `boolean` | 设置滚动边界弹性 (仅在 iOS 下生效) | -| showScrollbar | `boolean` | 设置是否显示滚动条 | -| pagingEnabled | `boolean` | 分页滑动开关 | -| fastDeceleration | `boolean` | 设置滚动减速速率 | -| decelerationDisabled | `boolean` | 取消滚动惯性 (仅在 iOS 下生效) | - -### scrollTo - -滚动至指定位置 - -支持情况： - -> H5: 不支持 velocity 参数 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollTo.html) - -```tsx -(object: Option) => void -``` - -| 参数 | 类型 | -| --- | --- | -| object | `Option` | - -### scrollIntoView - -滚动至指定位置 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollIntoView.html) - -```tsx -(selector: string) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| selector | `string` | 元素选择器 | - -## 参数 - -### scrollTo - -#### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| top | `number` | 否 | 顶部距离 | -| left | `number` | 否 | 左边界距离 | -| velocity | `number` | 否 | 初始速度 | -| duration | `number` | 否 | 滚动动画时长 | -| animated | `boolean` | 否 | 是否启用滚动动画 | - -## 示例代码 - -```tsx -Taro.createSelectorQuery() - .select('#scrollview') - .node() - .exec((res) => { - const scrollView = res[0].node; - scrollView.scrollEnabled = false; - }) -``` - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| ScrollViewContext | ✔️ | | | | | -| ScrollViewContext.scrollTo | ✔️ | | ✔️(不支持 velocity 参数) | | | -| ScrollViewContext.scrollIntoView | ✔️ | ✔️ | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/ui/scroll/pageScrollTo.md b/versioned_docs/version-4.x/apis/ui/scroll/pageScrollTo.md deleted file mode 100644 index b65512e4cfb0..000000000000 --- a/versioned_docs/version-4.x/apis/ui/scroll/pageScrollTo.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Taro.pageScrollTo(option) -sidebar_label: pageScrollTo ---- - -将页面滚动到目标位置，支持选择器和滚动距离两种方式定位 - -**selector 语法** -selector类似于 CSS 的选择器，但仅支持下列语法。 - -- ID选择器：#the-id -- class选择器（可以连续指定多个）：.a-class.another-class -- 子元素选择器：.the-parent > .the-child -- 后代选择器：.the-ancestor .the-descendant -- 跨自定义组件的后代选择器：.the-ancestor >>> .the-descendant -- 多选择器的并集：#a-node, .some-other-nodes - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| duration | `number` | 否 | 滚动动画的时长，单位 ms | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| scrollTop | `number` | 否 | 滚动到页面的目标位置，单位 px | -| selector | `string` | 否 | 选择器, css selector | -| offsetTop | `number` | 否 | 偏移距离，需要和 selector 参数搭配使用，可以滚动到 selector 加偏移距离的位置，单位 px | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.pageScrollTo({ - scrollTop: 0, - duration: 300 -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/sticky/setTopBarText.md b/versioned_docs/version-4.x/apis/ui/sticky/setTopBarText.md deleted file mode 100644 index 8d4986699f4b..000000000000 --- a/versioned_docs/version-4.x/apis/ui/sticky/setTopBarText.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Taro.setTopBarText(option) -sidebar_label: setTopBarText ---- - -动态设置置顶栏文字内容。只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容. - -**注意** -- 调用成功后，需间隔 5s 才能再次调用此接口，如果在 5s 内再次调用此接口，会回调 fail，errMsg："setTopBarText: fail invoke too frequently" - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/sticky/wx.setTopBarText.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| text | `string` | 是 | 置顶栏文字 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | - -## 示例代码 - -```tsx -Taro.setTopBarText({ - text: 'hello, world!' -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBar.md b/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBar.md deleted file mode 100644 index 242f5cc02d04..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBar.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.hideTabBar(option) -sidebar_label: hideTabBar ---- - -隐藏 tabBar - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| animation | `boolean` | 否 | 是否需要动画效果 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBarRedDot.md b/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBarRedDot.md deleted file mode 100644 index 490fbb90e41f..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/hideTabBarRedDot.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.hideTabBarRedDot(option) -sidebar_label: hideTabBarRedDot ---- - -隐藏 tabBar 某一项的右上角的红点 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| index | `number` | 是 | tabBar 的哪一项，从左边算起 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/removeTabBarBadge.md b/versioned_docs/version-4.x/apis/ui/tab-bar/removeTabBarBadge.md deleted file mode 100644 index b66a1a15ed13..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/removeTabBarBadge.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.removeTabBarBadge(option) -sidebar_label: removeTabBarBadge ---- - -移除 tabBar 某一项右上角的文本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| index | `number` | 是 | tabBar 的哪一项，从左边算起 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarBadge.md b/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarBadge.md deleted file mode 100644 index 62569d376fdc..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarBadge.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Taro.setTabBarBadge(option) -sidebar_label: setTabBarBadge ---- - -为 tabBar 某一项的右上角添加文本 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarBadge.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| index | `number` | 是 | tabBar 的哪一项，从左边算起 | -| text | `string` | 是 | 显示的文本，超过 4 个字符则显示成 ... | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setTabBarBadge({ - index: 0, - text: '1' -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarItem.md b/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarItem.md deleted file mode 100644 index 1f5d62657910..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarItem.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.setTabBarItem(option) -sidebar_label: setTabBarItem ---- - -动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarItem.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| index | `number` | 是 | tabBar 的哪一项，从左边算起 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| iconPath | `string` | 否 | 图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px，当 postion 为 top 时，此参数无效 | -| selectedIconPath | `string` | 否 | 选中时的图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px ，当 postion 为 top 时，此参数无效 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| text | `string` | 否 | tab 上的按钮文字 | - -## 示例代码 - -```tsx -Taro.setTabBarItem({ - index: 0, - text: 'text', - iconPath: '/path/to/iconPath', - selectedIconPath: '/path/to/selectedIconPath' -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarStyle.md b/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarStyle.md deleted file mode 100644 index 6486816bc1bc..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/setTabBarStyle.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Taro.setTabBarStyle(option) -sidebar_label: setTabBarStyle ---- - -动态设置 tabBar 的整体样式 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarStyle.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| backgroundColor | `string` | 否 | tab 的背景色，HexColor | -| borderStyle | `string` | 否 | tabBar上边框的颜色， 仅支持 black/white | -| color | `string` | 否 | tab 上的文字默认颜色，HexColor | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| selectedColor | `string` | 否 | tab 上的文字选中时的颜色，HexColor | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | - -## 示例代码 - -```tsx -Taro.setTabBarStyle({ - color: '#FF0000', - selectedColor: '#00FF00', - backgroundColor: '#0000FF', - borderStyle: 'white' -}) -``` diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBar.md b/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBar.md deleted file mode 100644 index eab31b10744d..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBar.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.showTabBar(option) -sidebar_label: showTabBar ---- - -显示 tabBar - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.html) - -## 类型 - -```tsx -(option?: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| animation | `boolean` | 否 | 是否需要动画效果 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBarRedDot.md b/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBarRedDot.md deleted file mode 100644 index d47caaca9008..000000000000 --- a/versioned_docs/version-4.x/apis/ui/tab-bar/showTabBarRedDot.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Taro.showTabBarRedDot(option) -sidebar_label: showTabBarRedDot ---- - -显示 tabBar 某一项的右上角的红点 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| index | `number` | 是 | tabBar 的哪一项，从左边算起 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/ui/window/checkIsPictureInPictureActive.md b/versioned_docs/version-4.x/apis/ui/window/checkIsPictureInPictureActive.md deleted file mode 100644 index 545482f2950c..000000000000 --- a/versioned_docs/version-4.x/apis/ui/window/checkIsPictureInPictureActive.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Taro.checkIsPictureInPictureActive() -sidebar_label: checkIsPictureInPictureActive ---- - -返回当前是否存在小窗播放（小窗在 video/live-player/live-pusher 下可用） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.checkIsPictureInPictureActive.html) - -## 类型 - -```tsx -() => boolean -``` diff --git a/versioned_docs/version-4.x/apis/ui/window/offWindowResize.md b/versioned_docs/version-4.x/apis/ui/window/offWindowResize.md deleted file mode 100644 index 9de94214dc6f..000000000000 --- a/versioned_docs/version-4.x/apis/ui/window/offWindowResize.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Taro.offWindowResize(callback) -sidebar_label: offWindowResize ---- - -取消监听窗口尺寸变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.offWindowResize.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 窗口尺寸变化事件的回调函数 | - -### Callback - -窗口尺寸变化事件的回调函数 - -```tsx -(res: TaroGeneral.CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `TaroGeneral.CallbackResult` | diff --git a/versioned_docs/version-4.x/apis/ui/window/onWindowResize.md b/versioned_docs/version-4.x/apis/ui/window/onWindowResize.md deleted file mode 100644 index 1c1e7a415e33..000000000000 --- a/versioned_docs/version-4.x/apis/ui/window/onWindowResize.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Taro.onWindowResize(callback) -sidebar_label: onWindowResize ---- - -监听窗口尺寸变化事件 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.onWindowResize.html) - -## 类型 - -```tsx -(callback: Callback) => void -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `Callback` | 窗口尺寸变化事件的回调函数 | - -### Callback - -窗口尺寸变化事件的回调函数 - -```tsx -(result: CallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `CallbackResult` | - -### CallbackResult - -| 参数 | 类型 | -| --- | --- | -| size | `Size` | - -### Size - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| windowHeight | `number` | 变化后的窗口高度，单位 px | -| windowWidth | `number` | 变化后的窗口宽度，单位 px | diff --git a/versioned_docs/version-4.x/apis/ui/window/setWindowSize.md b/versioned_docs/version-4.x/apis/ui/window/setWindowSize.md deleted file mode 100644 index de00d1882185..000000000000 --- a/versioned_docs/version-4.x/apis/ui/window/setWindowSize.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Taro.setWindowSize(option) -sidebar_label: setWindowSize ---- - -设置窗口大小，该接口仅适用于 PC 平台，使用细则请参见指南 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.setWindowSize.html) - -## 类型 - -```tsx -(option: Option) => Promise -``` - -## 参数 - -| 参数 | 类型 | -| --- | --- | -| option | `Option` | - -### Option - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| width | `string` | 是 | 窗口宽度，以像素为单位 | -| height | `string` | 是 | 窗口高度，以像素为单位 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/versioned_docs/version-4.x/apis/worker/Worker.md b/versioned_docs/version-4.x/apis/worker/Worker.md deleted file mode 100644 index 015e941a271c..000000000000 --- a/versioned_docs/version-4.x/apis/worker/Worker.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: Worker -sidebar_label: Worker ---- - -## 方法 - -### onMessage - -监听主线程/Worker 线程向当前线程发送的消息的事件。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.onMessage.html) - -```tsx -(callback: OnMessageCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnMessageCallback` | 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 | - -### onProcessKilled - -监听 worker 线程被系统回收事件（当 iOS 系统资源紧张时，worker 线程存在被系统回收的可能，开发者可监听此事件并重新创建一个 worker） - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.onProcessKilled.html) - -```tsx -(callback: OnMessageCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `OnMessageCallback` | worker 线程被系统回收事件的回调函数 | - -### postMessage - -向主线程/Worker 线程发送的消息。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.postMessage.html) - -```tsx -(message: TaroGeneral.IAnyObject) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| message | `TaroGeneral.IAnyObject` | 需要发送的消息，必须是一个可序列化的 JavaScript key-value 形式的对象。 | - -#### 示例代码 - -worker 线程中 - -```tsx -worker.postMessage({ - msg: 'hello from worker' -}) -``` - -主线程中 - -```tsx -const worker = Taro.createWorker('workers/request/index.js') -worker.postMessage({ - msg: 'hello from main' -}) -``` - -### terminate - -结束当前 Worker 线程。仅限在主线程 worker 对象上调用。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.terminate.html) - -```tsx -() => void -``` - -## 参数 - -### OnMessageCallback - -```tsx -(result: OnMessageCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `OnMessageCallbackResult` | - -### OnMessageCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| message | `TaroGeneral.IAnyObject` | 主线程/Worker 线程向当前线程发送的消息 | - -## API 支持度 - -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Worker.onMessage | ✔️ | | | | -| Worker.onProcessKilled | ✔️ | | | | -| Worker.postMessage | ✔️ | | | | -| Worker.terminate | ✔️ | | | | diff --git a/versioned_docs/version-4.x/apis/worker/createWorker.md b/versioned_docs/version-4.x/apis/worker/createWorker.md deleted file mode 100644 index 80fa9bec51e8..000000000000 --- a/versioned_docs/version-4.x/apis/worker/createWorker.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Taro.createWorker(scriptPath) -sidebar_label: createWorker ---- - -创建一个 Worker 线程。目前限制最多只能创建一个 Worker，创建下一个 Worker 前请先调用 [Worker.terminate](/docs/apis/worker/#terminate) - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html) - -## 类型 - -```tsx -(scriptPath: string) => Worker -``` - -## 参数 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| scriptPath | `string` | worker 入口文件的**绝对路径** | - -## 示例代码 - -```tsx -const worker = Taro.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径，绝对路径 - worker.onMessage(function (res) { - console.log(res) -}) -worker.postMessage({ - msg: 'hello worker' -}) -worker.terminate() -``` diff --git a/versioned_docs/version-4.x/apis/wxml/IntersectionObserver.md b/versioned_docs/version-4.x/apis/wxml/IntersectionObserver.md deleted file mode 100644 index 701a993a3823..000000000000 --- a/versioned_docs/version-4.x/apis/wxml/IntersectionObserver.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: IntersectionObserver -sidebar_label: IntersectionObserver ---- - -`IntersectionObserver` 对象，用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见。 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.html) - -## 方法 - -### disconnect - -停止监听。回调函数将不再触发 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.disconnect.html) - -```tsx -() => void -``` - -### observe - -指定目标节点并开始监听相交状态变化情况 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.observe.html) - -```tsx -(targetSelector: string, callback: ObserveCallback) => void -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| targetSelector | `string` | 选择器 | -| callback | `ObserveCallback` | 监听相交状态变化的回调函数 | - -### relativeTo - -使用选择器指定一个节点，作为参照区域之一。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.relativeTo.html) - -```tsx -(selector: string, margins?: RelativeToMargins) => IntersectionObserver -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| selector | `string` | 选择器 | -| margins | `RelativeToMargins` | 用来扩展（或收缩）参照节点布局区域的边界 | - -### relativeToViewport - -指定页面显示区域作为参照区域之一 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.relativeToViewport.html) - -```tsx -(margins?: RelativeToViewportMargins) => IntersectionObserver -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| margins | `RelativeToViewportMargins` | 用来扩展（或收缩）参照节点布局区域的边界 | - -#### 示例代码 - -下面的示例代码中，如果目标节点（用选择器 .target-class 指定）进入显示区域以下 100px 时，就会触发回调函数。 - -```tsx -Taro.createIntersectionObserver().relativeToViewport({bottom: 100}).observe('.target-class', (res) => { - res.intersectionRatio // 相交区域占目标节点的布局区域的比例 - res.intersectionRect // 相交区域 - res.intersectionRect.left // 相交区域的左边界坐标 - res.intersectionRect.top // 相交区域的上边界坐标 - res.intersectionRect.width // 相交区域的宽度 - res.intersectionRect.height // 相交区域的高度 -}) -``` - -## 参数 - -### ObserveCallback - -监听相交状态变化的回调函数 - -```tsx -(result: ObserveCallbackResult) => void -``` - -| 参数 | 类型 | -| --- | --- | -| result | `ObserveCallbackResult` | - -### ObserveCallbackResult - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| boundingClientRect | `BoundingClientRectResult` | 目标边界 | -| intersectionRatio | `number` | 相交比例 | -| intersectionRect | `IntersectionRectResult` | 相交区域的边界 | -| relativeRect | `RelativeRectResult` | 参照区域的边界 | -| time | `number` | 相交检测时的时间戳 | - -### RelativeRectResult - -参照区域的边界 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bottom | `number` | 下边界 | -| left | `number` | 左边界 | -| right | `number` | 右边界 | -| top | `number` | 上边界 | - -### IntersectionRectResult - -相交区域的边界 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bottom | `number` | 下边界 | -| height | `number` | 高度 | -| left | `number` | 左边界 | -| right | `number` | 右边界 | -| top | `number` | 上边界 | -| width | `number` | 宽度 | - -### BoundingClientRectResult - -目标边界 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| bottom | `number` | 下边界 | -| height | `number` | 高度 | -| left | `number` | 左边界 | -| right | `number` | 右边界 | -| top | `number` | 上边界 | -| width | `number` | 宽度 | - -### RelativeToMargins - -用来扩展（或收缩）参照节点布局区域的边界 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| bottom | `number` | 否 | 节点布局区域的下边界 | -| left | `number` | 否 | 节点布局区域的左边界 | -| right | `number` | 否 | 节点布局区域的右边界 | -| top | `number` | 否 | 节点布局区域的上边界 | - -### RelativeToViewportMargins - -用来扩展（或收缩）参照节点布局区域的边界 - -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| bottom | `number` | 否 | 节点布局区域的下边界 | -| left | `number` | 否 | 节点布局区域的左边界 | -| right | `number` | 否 | 节点布局区域的右边界 | -| top | `number` | 否 | 节点布局区域的上边界 | - -## API 支持度 - -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| IntersectionObserver.disconnect | ✔️ | ✔️ | ✔️ | | | -| IntersectionObserver.observe | ✔️ | ✔️ | ✔️ | | | -| IntersectionObserver.relativeTo | ✔️ | ✔️ | ✔️ | | | -| IntersectionObserver.relativeToViewport | ✔️ | ✔️ | ✔️ | | | diff --git a/versioned_docs/version-4.x/apis/wxml/MediaQueryObserver.md b/versioned_docs/version-4.x/apis/wxml/MediaQueryObserver.md deleted file mode 100644 index 0e5e911b84e9..000000000000 --- a/versioned_docs/version-4.x/apis/wxml/MediaQueryObserver.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: MediaQueryObserver -sidebar_label: MediaQueryObserver ---- - -`MediaQueryObserver` 对象，用于监听页面 media query 状态的变化，如界面的长宽是不是在某个指定的范围内。 - -## 方法 - -### observe - -开始监听页面 media query 变化情况 - -```tsx -(descriptor: descriptor, callback: observeCallback) => void -``` - -| 参数 | 类型 | -| --- | --- | -| descriptor | `descriptor` | -| callback | `observeCallback` | - -### disconnect - -停止监听。回调函数将不再触发 - -```tsx -() => void -``` - -## 参数 - -### descriptor - -media query 描述符 - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| minWidth | `number` | 页面最小宽度 (单位: px) | -| maxWidth | `number` | 页面最大宽度 (单位: px) | -| width | `number` | 页面宽度 (单位: px) | -| minHeight | `number` | 页面最小高度 (单位: px) | -| maxHeight | `number` | 页面最大高度（px 为单位） | -| height | `number` | 页面高度（px 为单位） | -| orientation | "landscape" or "portrait" | 屏幕方向 | - -### observeCallback - -监听 media query 状态变化的回调函数 - -```tsx -(res: { matches: boolean; }) => void -``` - -| 参数 | 类型 | -| --- | --- | -| res | `{ matches: boolean; }` | diff --git a/versioned_docs/version-4.x/apis/wxml/NodesRef.md b/versioned_docs/version-4.x/apis/wxml/NodesRef.md deleted file mode 100644 index 1bd77dbc1bcf..000000000000 --- a/versioned_docs/version-4.x/apis/wxml/NodesRef.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -title: NodesRef -sidebar_label: NodesRef ---- - -用于获取 `WXML` 节点信息的对象 - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.html) - -## 方法 - -### boundingClientRect - -添加节点的布局位置的查询请求。相对于显示区域，以像素为单位。其功能类似于 DOM 的 `getBoundingClientRect`。返回 `NodesRef` 对应的 `SelectorQuery`。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.boundingClientRect.html) - -```tsx -(callback?: BoundingClientRectCallback) => SelectorQuery -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `BoundingClientRectCallback` | 回调函数，在执行 `SelectorQuery.exec` 方法后，节点信息会在 `callback` 中返回。 | - -#### 示例代码 - -##### 示例 1 - -```tsx -Taro.createSelectorQuery().select('#the-id').boundingClientRect(function(rect){ - rect.id // 节点的ID - rect.dataset // 节点的dataset - rect.left // 节点的左边界坐标 - rect.right // 节点的右边界坐标 - rect.top // 节点的上边界坐标 - rect.bottom // 节点的下边界坐标 - rect.width // 节点的宽度 - rect.height // 节点的高度 -}).exec() - -##### 示例 2 - -``` -```tsx -Taro.createSelectorQuery().selectAll('.a-class').boundingClientRect(function(rects){ - rects.forEach(function(rect){ - rect.id // 节点的ID - rect.dataset // 节点的dataset - rect.left // 节点的左边界坐标 - rect.right // 节点的右边界坐标 - rect.top // 节点的上边界坐标 - rect.bottom // 节点的下边界坐标 - rect.width // 节点的宽度 - rect.height // 节点的高度 - }) -}).exec() -``` - -### context - -添加节点的 Context 对象查询请求。目前支持 [VideoContext](/docs/apis/media/video/VideoContext)、[CanvasContext](/docs/apis/canvas/CanvasContext)、[LivePlayerContext](/docs/apis/media/live/LivePlayerContext)、[EditorContext](/docs/apis/media/editor/EditorContext)和 [MapContext](/docs/apis/media/map/MapContext) 的获取。 - -支持情况： - -> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.context.html) - -```tsx -(callback?: ContextCallback) => SelectorQuery -``` - -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| callback | `ContextCallback` | 回调函数，在执行 `SelectorQuery.exec` 方法后，返回节点信息。 | - -#### 示例代码 - -```tsx -Taro.createSelectorQuery().select('.the-video-class').context(function (res) { - console.log(res.context) // 节点对应的 Context 对象。如：选中的节点是

- - -``` - -```js title="app.config.js" -export default { - appId: 'app', -} -``` - -### animation - -指定 H5 端动画配置，可以通过覆盖 CSS 样式调整动画。 - -#### RouterAnimate - -```ts -interface RouterAnimate { - /** - * 动画切换时间，单位毫秒 - * @default 300 - */ - duration?: number - /** - * 动画切换时间，单位毫秒 - * @default 50 - */ - delay?: number -} -``` - -#### 代码示例 - -```js title="app.config.js" -export default { - animation: false, -} -``` diff --git a/versioned_docs/version-4.x/babel-config.md b/versioned_docs/version-4.x/babel-config.md deleted file mode 100644 index b2d4b71b1c86..000000000000 --- a/versioned_docs/version-4.x/babel-config.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: Babel 配置 ---- - -Taro 项目的 Babel 配置位于根目录的 `babel.config.js` 文件中，里面默认添加了一个 preset：`babel-preset-taro`，它会根据项目的技术栈添加一些常用的 `presets` 和 `plugins`。 - -```js title="babel.config.js" -module.exports = { - presets: [ - [ - 'taro', - { - /** 配置项 */ - }, - ], - ], -} -``` - -开发者可以修改 `babel.config.js`，修改 `babel-preset-taro` 的配置项，或添加自己想要的 `presets` 和 `plugins`。 - -## babel-preset-taro - -`babel-preset-taro` 会根据当前项目的技术栈，选择性地使用以下的 `presets` 和 `plugins`。 - -#### 1. 通用 - -##### presets - -- `@babel/preset-env` -- `@babel/preset-typescript`（TypeScript 环境） - -##### plugins - -- `@babel/plugin-transform-runtime` -- `@babel/plugin-proposal-decorators` -- `@babel/plugin-proposal-class-properties` -- `babel-plugin-dynamic-import-node`（小程序环境） - -#### 2. React - -##### presets - -- `@babel/preset-react` - -##### plugins - -- `react-refresh/babel` - -#### 3. Vue - -##### presetes - -- `@vue/babel-preset-jsx` - -#### 4. Vue3 - -##### plugins - -- `@vue/babel-plugin-jsx` - -以下将详细介绍 `babel-preset-taro` 的配置项。 - -### reactJsxRuntime - -:::note -只在使用 **React** 时生效。 -::: - -**默认值**：`'automatic'` - -`@babel/preset-react` 的 [runtime](https://babeljs.io/docs/en/babel-preset-react#runtime) 配置项。 - -### ts - -:::note -使用 Typescript -::: - -### hot - -:::note -只在使用 **React** 时生效。 -::: - -**默认值**：`true` - -是否引入 `react-refresh/babel` 来支持使用 [fast-refresh](h5#fast-refresh)。 - -### vueJsx - -:::note -只在使用 **Vue/Vue3** 时生效。 -::: - -**默认值**：`true` - -**类型**：`true` | `false` | `object` - -是否使用 `@vue/babel-preset-jsx`（Vue）或 `@vue/babel-plugin-jsx`（Vue3）来支持使用 `jsx`。 - -当传入一个 `object` 时，等同于设置为 `true`，且该 `object` 将会作为 `@vue/babel-preset-jsx`（Vue）或 `@vue/babel-plugin-jsx`（Vue3）的参数。 - -### targets - -**默认值**： - -```js -{ - ios: '9', - android: '5' -} -``` - -`@babel/preset-env` 的 [targets](https://babeljs.io/docs/en/babel-preset-env#targets) 配置项。 - -### useBuiltIns - -**默认值**：`false` - -**有效值**：`'entry'` | `'usage'` | `false` - -#### useBuiltIns: 'entry' - -:::info -**优点**：全局彻底 polyfill，就算 `node_modules` 中的依赖存在不兼容的代码，也能成功运行。 - -**缺点**：可能会引入冗余代码、影响全局变量。 -::: - -当传入 `'entry'` 时，会把 `@babel/preset-env` 的 [useBuiltIns](https://babeljs.io/docs/en/babel-preset-env#usebuiltins) 选项设为 `'entry'`、[corejs](https://babeljs.io/docs/en/babel-preset-env#corejs) 选项设为 `'3'`。 - -开发者需要在入口文件 `app.js` 中引入 `core-js`： - -```js title="src/app.js" -import 'core-js' -``` - -Babel 会根据 [targets](babel-config#targets)，引入对应的 `core-js` 依赖。例如上述代码会被编译为： - -```js title="dist/app.js" -import 'core-js/modules/es.string.pad-start' -import 'core-js/modules/es.string.pad-end' -// ... -``` - -> 当然，因为这时 Taro 把 `corejs` 设置为 `'3'`，所以可以使用 `core-js@3` **手动按需引入的能力**，详情请见[文档](https://babeljs.io/docs/en/babel-preset-env#usebuiltins)。 - -#### useBuiltIns: 'usage' - -:::info -**优点**：按需引入、不会影响全局变量。 - -**缺点**：默认不会处理 `node_modules` 中的依赖，需要手动配置 `babel-loader`。 -::: - -当传入 `'usage'` 时，会把 `@babel/plugin-transform-runtime` 的 [corejs](https://babeljs.io/docs/en/babel-plugin-transform-runtime#corejs) 选项设为 `3`。 - -> 注意：传入 `'usage'` 时， Taro 没有使用 `@babel/preset-env` 的 `useBuiltIns: 'usage'` 而是使用了 `@babel/plugin-transform-runtime` 的 `corejs: 3`。原因在于：一、两者同时设置时会产生冲突。二、后者相对于前者，不会影响全局变量。 - -#### useBuiltIns: false - -当传入 `false` 时，会把 `@babel/preset-env` 的 [useBuiltIns](https://babeljs.io/docs/en/babel-preset-env#usebuiltins) 选项设为 `false`，此时不会引入 `core-js`。 - -### loose - -**默认值**：`false` - -同时是 `@babel/preset-env`、`@babel/plugin-proposal-class-properties` 的 `loose` 配置项。 - -### debug - -**默认值**：`false` - -`@babel/preset-env` 的 [debug](https://babeljs.io/docs/en/babel-preset-env#debug) 配置项。 - -### modules - -**默认值**：`false` - -`@babel/preset-env` 的 [modules](https://babeljs.io/docs/en/babel-preset-env#modules) 配置项。 - -### spec - -`@babel/preset-env` 的 [spec](https://babeljs.io/docs/en/babel-preset-env#spec) 配置项。 - -### configPath - -`@babel/preset-env` 的 [configPath](https://babeljs.io/docs/en/babel-preset-env#configpath) 配置项。 - -### include - -`@babel/preset-env` 的 [include](https://babeljs.io/docs/en/babel-preset-env#include) 配置项。 - -### exclude - -`@babel/preset-env` 的 [exclude](https://babeljs.io/docs/en/babel-preset-env#exclude) 配置项。 - -### shippedProposals - -`@babel/preset-env` 的 [shippedProposals](https://babeljs.io/docs/en/babel-preset-env#shippedproposals) 配置项。 - -### forceAllTransforms - -`@babel/preset-env` 的 [forceAllTransforms](https://babeljs.io/docs/en/babel-preset-env#forcealltransforms) 配置项。 - -### decoratorsBeforeExport - -`@babel/plugin-proposal-decorators` 的 [decoratorsBeforeExport](https://babeljs.io/docs/en/babel-plugin-proposal-decorators#decoratorsbeforeexport) 配置项。 - -### decoratorsLegacy - -**默认值**：`true` - -`@babel/plugin-proposal-decorators` 的 [lagacy](https://babeljs.io/docs/en/babel-plugin-proposal-decorators#legacy) 配置项。 - -### absoluteRuntime - -**默认值**：开发者根目录 `node_modules` 中的 `@babel/plugin-transform-runtime` 的路径。 - -**类型**：`string` - -`@babel/plugin-transform-runtime` 的 [absoluteRuntime](https://babeljs.io/docs/en/babel-plugin-transform-runtime#absoluteruntime) 配置项。 - -### version - -**默认值**：开发者根目录 `node_modules` 中的 `@babel/plugin-transform-runtime` 的版本号。 - -**类型**：`string` - -`@babel/plugin-transform-runtime` 的 [version](https://babeljs.io/docs/en/babel-plugin-transform-runtime#version) 配置项。 - -### dynamic-import-node - -:::note -可以去掉冗余代码，对于一些严格限制包体大小的场景（比如 PWA 等）有帮助，但这也会去掉页面和组件的懒加载，导致 app.js 过大。 - -> 注意：**h5** 平台默认关闭，其他平台默认开启，小程序默认是不支持动态加载的，可以通过[dynamic-import 插件](https://github.com/JiyuShao/taro-dynamic-import-weapp/tree/master/packages/taro-plugin-dynamic-import-weapp)提供该能力。 -> ::: - -**类型**：`boolean` diff --git a/versioned_docs/version-4.x/best-practice.md b/versioned_docs/version-4.x/best-practice.md deleted file mode 100644 index d495bf125548..000000000000 --- a/versioned_docs/version-4.x/best-practice.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -title: 最佳实践 ---- - -## 关于 JSX 支持程度补充说明 - -由于 JSX 中的写法千变万化，我们不能支持到所有的 JSX 写法，同时由于微信小程序端的限制，也有部分 JSX 的优秀用法暂时不能得到很好地支持，特在此补充说明一下对于 JSX 的支持程度: - -- [不能使用 Array#map 之外的方法操作 JSX 数组](https://github.com/NervJS/taro/blob/master/packages/eslint-plugin-taro/docs/manipulate-jsx-as-array.md) -- [暂不支持在 render() 之外的方法定义 JSX](https://github.com/NervJS/taro/blob/master/packages/eslint-plugin-taro/docs/no-jsx-in-class-method.md) (自 v1.3.0-beta.0 起支持) -- [不能在 JSX 参数中使用对象展开符](https://github.com/NervJS/taro/blob/master/packages/eslint-plugin-taro/docs/no-spread-in-props.md) (自 v1.3.0-beta.0 起，自定义组件可以使用对象展开符，内置组件仍然需要分别单独传入参数) -- [不支持无状态组件](https://github.com/NervJS/taro/blob/master/packages/eslint-plugin-taro/docs/no-stateless-function.md) (自 v1.3.0-beta.0 起支持) - -以上的规则在 Taro 默认生成的模板都有 ESLint 检测，无需做任何配置。如果你的编辑器没有安装 ESLint 插件可以参考以下教程在你的编辑器安装： - -- [VSCode](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) -- [IntelliJ IDEA(WebStorm 等 JetBrains 系)](https://www.jetbrains.com/help/idea/eslint.html) -- [Sublime Text](https://packagecontrol.io/packages/ESLint) - -默认情况下 Taro 的编译器也会对无法运行的代码进行警告，当没有调用栈信息时代码是可以生成的。如果你需要在编译时禁用掉 ESLint 检查，可以在命令前加入 `ESLINT=false` 参数，例如： - -```bash -$ ESLINT=false taro build --type weapp --watch -``` - -## 最佳编码方式 - -经过较长时间的探索与验证，目前 Taro 在微信小程序端是采用依托于小程序原生自定义组件系统来设计实现 Taro 组件化的，所以目前小程序端的组件化会受到小程序原生组件系统的限制，而同时为了实现以 React 方式编写代码的目标，Taro 本身做了一些编译时以及运行时的处理，这样也带来了一些值得注意的约束，所以有必要阐述一下 Taro 编码上的最佳实践。 - -### 组件样式说明 - -微信小程序的[自定义组件样式](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html)默认是不能受外部样式影响的，例如在页面中引用了一个自定义组件，在页面样式中直接写自定义组件元素的样式是无法生效的。这一点，在 Taro 中也是一样，而这也是与大家认知的传统 Web 开发不太一样。 - -### 给组件设置 `defaultProps` - -在微信小程序端的自定义组件中，只有在 `properties` 中指定的属性，才能从父组件传入并接收 - -```jsx -Component({ - properties: { - myProperty: { // 属性名 - type: String, // 类型（必填），目前接受的类型包括：String, Number, Boolean, Object, Array, null（表示任意类型） - value: '', // 属性初始值（可选），如果未指定则会根据类型选择一个 - observer: function (newVal, oldVal, changedPath) { - // 属性被改变时执行的函数（可选），也可以写成在 methods 段中定义的方法名字符串, 如：'_propertyChange' - // 通常 newVal 就是新设置的数据， oldVal 是旧数据 - } - }, - myProperty2: String // 简化的定义方式 - } - ... -}) -``` - -而在 Taro 中，对于在组件代码中使用到的来自 `props` 的属性，会在编译时被识别并加入到编译后的 `properties` 中，暂时支持到了以下写法 - -```jsx -this.props.property - -const { property } = this.props - -const property = this.props.property -``` - -但是一千个人心中有一千个哈姆雷特，不同人的代码写法肯定也不尽相同，所以 Taro 的编译肯定不能覆盖到所有的写法，而同时可能会有某一属性没有使用而是直接传递给子组件的情况，这种情况是编译时无论如何也处理不到的，这时候就需要大家在编码时给组件设置 [`defaultProps`](./apis/about/tarocomponent.md#defaultprops) 来解决了。 - -组件设置的 `defaultProps` 会在运行时用来弥补编译时处理不到的情况，里面所有的属性都会被设置到 `properties` 中初始化组件，正确设置 `defaultProps` 可以避免很多异常的情况的出现。 - -### 组件传递函数属性名以 `on` 开头 - -> 在 v1.3.0-beta.0 之后，自定义组件间的事件传递可以不用 `on` 开头，但内置组件的事件依然是以 `on` 开头的，为了一致性我们仍然推荐你以 `on` 开头命名你的事件。 - -在 Taro 中，父组件要往子组件传递函数，属性名必须以 `on` 开头 - -```jsx -// 调用 Custom 组件，传入 handleEvent 函数，属性名为 onTrigger -class Parent extends Component { - handleEvent() {} - - render() { - return - } -} -``` - -这是因为，微信小程序端组件化是不能直接传递函数类型给子组件的，在 Taro 中是借助组件的[事件机制](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/events.html)来实现这一特性，而小程序中传入事件的时候属性名写法为 `bindmyevent` 或者 `bind:myevent` - -```xml - - - - -``` - -所以 Taro 中约定组件传递函数属性名以 `on` 开头，同时这也和内置组件的事件绑定写法保持一致了。 - -### 小程序端不要在组件中打印传入的函数 - -> 自 v1.3.0-beta.0 没有这条限制 - -前面已经提到小程序端的组件传入函数的原理，所以在小程序端不要在组件中打印传入的函数，因为拿不到结果，但是 `this.props.onXxx && this.props.onXxx()` 这种判断函数是否传入来进行调用的写法是完全支持的。 - -### 小程序端不要将在模板中用到的数据设置为 `undefined` - -由于小程序不支持将 data 中任何一项的 value 设为 `undefined` ，在 setState 的时候也请避免这么用。你可以使用 null 来替代。 - -### 小程序端不要在组件中打印 `this.props.children` - -在微信小程序端是通过 `` 来实现往自定义组件中传入元素的，而 Taro 利用 `this.props.children` 在编译时实现了这一功能， `this.props.children` 会直接被编译成 `` 标签，所以它在小程序端属于语法糖的存在，请不要在组件中打印它。 - -### 支持 props 传入 JSX - -> 自 `1.1.9` 开始支持 - -支持 props 传入 JSX，但是元素传入 JSX 的属性名必须以 `render` 开头 - -例如，子组件写法 - -```javascript -class Dialog extends Component { - render() { - return ( - - {this.props.renderHeader} - {this.props.children} - {this.props.renderFooter} - - ) - } -} -``` - -父组件调用子组件是传入 JSX - -```javascript -class App extends Component { - render() { - return ( - - Welcome!} - renderFooter={} - > - Thank you for using Taro. - - - ) - } -} -``` - -### 组件属性传递注意 - -不要以 `id`、`class`、`style` 作为自定义组件的属性与内部 state 的名称，因为这些属性名在微信小程序小程序中会丢失。 - -### 组件 `state` 与 `props` 里字段重名的问题 - -不要在 `state` 与 `props` 上用同名的字段，因为这些字段在微信小程序中都会挂在 `data` 上。 - -### 小程序中页面生命周期 `componentWillMount` 不一致问题 - -由于微信小程序里页面在 `onLoad` 时才能拿到页面的路由参数，而页面 onLoad 前组件都已经 `attached` 了。因此页面的 `componentWillMount` 可能会与预期不太一致。例如： - -```jsx -// 错误写法 -render () { - // 在 willMount 之前无法拿到路由参数 - const abc = this.$router.params.abc - return -} - -// 正确写法 -componentWillMount () { - const abc = this.$router.params.abc - this.setState({ - abc - }) -} -render () { - // 增加一个兼容判断 - return this.state.abc && -} -``` - -对于不需要等到页面 willMount 之后取路由参数的页面则没有任何影响。 - -### 组件的 `constructor` 与 `render` 提前调用 - -很多细心的开发者应该已经注意到了，在 Taro 编译到小程序端后，组件的 `constructor` 与 `render` 默认会多调用一次，表现得与 React 不太一致。 - -这是因为，Taro 的组件编译后就是小程序的自定义组件，而小程序的自定义组件的初始化时是可以指定 `data` 来让组件拥有初始化数据的。开发者一般会在组件的 `constructor` 中设置一些初始化的 `state`，同时也可能会在 `render` 中处理 `state` 与 `props` 产生新的数据，在 Taro 中多出的这一次提前调用，就是为了收集组件的初始化数据，给自定义组件提前生成 `data` ，以保证组件初始化时能带有数据，让组件初次渲染正常。 - -所以，在编码时，需要在处理数据的时候做一些容错处理，这样可以避免在 `constructor` 与 `render` 提前调用时出现由于没有数据导致出错的情况。 - -### JS 编码必须用单引号 - -在 Taro 中，JS 代码里必须书写单引号，特别是 JSX 中，如果出现双引号，可能会导致编译错误。 - -### 环境变量 `process.env` 的使用 - -不要以解构的方式来获取通过 `env` 配置的 `process.env` 环境变量，请直接以完整书写的方式 `process.env.NODE_ENV` 来进行使用 - -```jsx -// 错误写法，不支持 -const { NODE_ENV = 'development' } = process.env -if (NODE_ENV === 'development') { - ... -} - -// 正确写法 -if (process.env.NODE_ENV === 'development') { - -} -``` - -### 使用 `this.$componentType` 来判断当前 Taro.Component 是页面还是组件 - -`this.$componentType` 可能取值分别为 `PAGE` 和 `COMPONENT`，开发者可以根据此变量的取值分别采取不同逻辑。 - -### 原生小程序组件传递 props 给 Taro 组件 - -**Taro v1.3+** 对 props 系统进行了改造，使得不能兼容原生组件通过 properties 传入的属性。 - -目前可以通过把所有需要传入 Taro 组件的 props，通过借助 `extraProps` 属性来解决。 - -```js -// 小程序组件常规 props 传递 - - -// 原生小程序组件调用 Taro 组件时需要改造成以下形式： -this.setData({ - extraProps: { - name, - desc, - onClick: this.onClick - } -}) - -``` - -## 全局变量 - -在 Taro 中推荐使用 `Redux` 来进行全局变量的管理，但是对于一些小型的应用， `Redux` 就可能显得比较重了，这时候如果想使用全局变量，推荐如下使用。 - -新增一个自行命名的 `JS` 文件，例如 `global_data.js`，示例代码如下 - -```jsx -const globalData = {} - -export function set(key, val) { - globalData[key] = val -} - -export function get(key) { - return globalData[key] -} -``` - -随后就可以在任意位置进行使用啦 - -```jsx -import { set as setGlobalData, get as getGlobalData } from './path/name/global_data' - -setGlobalData('test', 1) - -getGlobalData('test') -``` diff --git a/versioned_docs/version-4.x/children.md b/versioned_docs/version-4.x/children.md deleted file mode 100644 index 52a7ac177a27..000000000000 --- a/versioned_docs/version-4.x/children.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Children 与组合 ---- - -> 经测试，由于微信小程序的 `` 无法在循环中使用，因此 Children 和组合在微信小程序中也无法在循环中使用。百度小程序、支付宝小程序、H5、React Native 都可以在循环中使用此功能。 - -## Children - -在我们设计组件时，有些组件通常不知道自己的子组件会有什么内容，例如 `Sidebar` 和 `Dialog` 这样的容器组件。 - -我们建议在这样的情况使用 `this.props.children` 来传递子元素： - -```jsx -class Dialog extends Component { - render() { - return ( - - Welcome! - {this.props.children} - -- divider -- - - ) - } -} -``` - -这样就能允许其它组件在 JSX 中嵌套任意子组件传递给 `Dialog`: - -```jsx -class App extends Component { - render() { - return ( - - - Thank you for using Taro. - - - ) - } -} -``` - -在 `` JSX 标签内的任何内容都会作为它的子元素(Children)都会传递到它的组件。 - -### 注意事项 - -**请不要对 `this.props.children` 进行任何操作**。Taro 在小程序中实现这个功能使用的是小程序的 [`slot`](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/wxml-wxss.html) 功能，也就是说你可以把 `this.props.children` 理解为 `slot` 的语法糖，`this.props.children` 在 Taro 中并不是 React 的 `ReactElement` 对象，因此形如 `this.props.children && this.props.children`、`this.props.children[0]` 在 Taro 中都是非法的。 - -**`this.props.children` 无法用 `defaultProps` 设置默认内容**。由于小程序的限制，Taro 也无法知道组件的消费者是否传入内容，所以无法应用默认内容。 - -**不能把 `this.props.children` 分解为变量再使用**。由于普通的 `props` 有一个确切的值，所以当你把它们分解为变量运行时可以处理，`this.props.children` 则不能这样操作，你必须显性地把 `this.props.children` 全部都写完整才能实现它的功能。 - -## 组合 - -> 自 `1.1.9` 开始支持 - -有些情况你不仅仅需要只传递一个子组件，可能会需要很多个「占位符」。例如在这个 `Dialog` 组件中，你不仅需要自定义它的 `body`，你希望它的 `header` 和 `footer` 都是给 `Dialog` 组件的使用者自由定制。这种情况可以这样做： - -```jsx -class Dialog extends Component { - render() { - return ( - - {this.props.renderHeader} - {this.props.children} - {this.props.renderFooter} - - ) - } -} - -class App extends Component { - render() { - return ( - - Welcome!} - renderFooter={} - > - Thank you for using Taro. - - - ) - } -} -``` - -在我们声明 `Dialog` 组件时，`header` 和 `footer` 部分我们分别增加了 `this.props.renderHeader` 和 `this.props.renderFooter` 作为占位符。相应地，我们在使用 `Dialog` 组件时，就可以给 `renderHeader` 和 `renderFooter` 传入 JSX 元素，这两个分别传入的 JSX 元素将会填充它们在 `Dialog` 组件中的位置——就像在 `Dialog` JSX 标签里写入的内容，会填充到 `this.props.children` 的位置一样。 - -### 注意事项 - -**组件的组合需要遵守 `this.props.children` 的所有规则**。组合这个功能和 `this.props.children` 一样是通过 `slot` 实现的，也就是说 `this.props.children` 的限制对于组件组合也都同样适用。 - -**所有组合都必须用 `render` 开头，且遵守驼峰式命名法**。和我们的事件规范以 `on` 开头一样，组件组合使用 `render` 开头。 - -**组合只能传入单个 JSX 元素，不能传入其它任何类型**。当你需要进行一些条件判断或复杂逻辑操作的时候，可以使用一个 `Block` 元素包裹住，然后在 `Block` 元素的里面填充其它复杂的逻辑。 diff --git a/versioned_docs/version-4.x/cli.md b/versioned_docs/version-4.x/cli.md deleted file mode 100644 index b51a0729a6a7..000000000000 --- a/versioned_docs/version-4.x/cli.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: CLI 命令 ---- - -常用的 Taro CLI 命令。 - -### 查看 Taro 所有命令及帮助 - -```bash -$ taro --help -``` - -### 环境及依赖检测 - -Taro 提供了命令来一键检测 Taro 环境及依赖的版本等信息，方便大家查看项目的环境及依赖，排查环境问题。在提 issue 的时候，请附上 `taro info` 打印的信息，帮助开发人员快速定位问题。 - -```bash -$ taro info -👽 Taro v4.0.0-beta.1 - - Taro CLI 4.0.0-beta.1 environment info: - System: - OS: macOS 12.1 - Shell: 5.8 - /bin/zsh - Binaries: - Node: 16.20.0 - ~/.nvm/versions/node/v16.20.0/bin/node - Yarn: 1.22.15 - /usr/local/bin/yarn - npm: 8.19.4 - ~/.nvm/versions/node/v16.20.0/bin/npm - npmPackages: - @tarojs/cli: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/components: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/helper: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/mini-runner: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-framework-react: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-alipay: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-h5: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-jd: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-qq: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-swan: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-tt: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/plugin-platform-weapp: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/react: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/router: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/runtime: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/shared: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/taro: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/webpack-runner: 4.0.0-beta.1 => 4.0.0-beta.1 - @tarojs/webpack5-runner: 4.0.0-beta.1 => 4.0.0-beta.1 - babel-preset-taro: 4.0.0-beta.1 => 4.0.0-beta.1 - eslint-config-taro: 4.0.0-beta.1 => 4.0.0-beta.1 - react: ^18.0.0 => 18.2.0 - -``` - -### Taro Doctor - -Taro Doctor 就像一个医生一样，可以诊断项目的依赖、设置、结构，以及代码的规范是否存在问题，并尝试给出解决方案。 - -但和真正的医生不一样，Taro Doctor 不需要排队挂号，也不用花钱。你只需要在终端运行命令：`taro doctor`，就像图里一样： - -![Taro Doctor 诊断结果图](https://img10.360buyimg.com/ling/jfs/t1/46613/36/5573/202581/5d357d14E6f0df7e1/fc026be7dc69dcf2.png) - -### 快速创建新页面 - -Taro create --name [页面名称] --dir [路径] --subpkg [分包路径] 能够在当前项目的指定目录下快速生成新的页面文件，并填充基础代码，是一个提高开发效率的利器。 - -> taro 会尝试同步修改 `app.config.js` 配置文件中的 `pages` 或者 `subPackages` 字段。 - -#### 例子 -假设当前当前跟路径为 `/project/root`。 - -执行下面命令创建主包页面： -```bash -taro create newPage --dir pages/mydir -``` -那么会在 `/project/root/src/pages/mydir` 目录下生成新的页面，并且在 `app.config.js` 中自动补齐 `pages` 字段。 - -执行下面命令创建分包页面： -```bash -taro create newPage --subpkg mysubpages -``` -那么会在 `/project/root/src/mysubpages` 目录下生成新的页面，并且在 `app.config.js` 中自动补齐 `subPackages` 字段。 - -### 快速创建插件模版 - -参考 [插件编写](./plugin-custom.md) - -### CLI 配置 - -Taro 会在用户根目录下创建 .taro 文件夹，其中 .taro/index.json 用于存放 CLI 相关配置。 - -开发者可以使用 `taro config` 命令对配置项进行一系列操作： - -```bash -# 查看用法 -$ taro config --help -# 设置配置项的值为 -$ taro config set -# 读取配置项 -$ taro config get -# 删除配置项 -$ taro config delete -# 打印所有配置项 -$ taro config list [--json] -``` - -### 全局插件或插件集配置 - -Taro 会在用户根目录下创建 .taro-global-config 文件夹，用于在执行 CLI 阶段时，如果没有获取到项目的配置文件，可以从该文件夹下读取全局的配置。 - -目前开发了 插件（plugins）和 插件集（presets）这两个可配置项。 -有了这一配置，Taro 将支持在没有项目配置文件时，去执行一些插件。这些插件大部分是一些自定义命令类型的插件。 - -开发者可以使用 `taro global-config` 命令对配置项进行一系列操作： - -```bash -# 查看用法 -$ taro global-config --help -# 添加全局插件 -$ taro global-config add-plugin [pluginName] -# 删除全局插件 -$ taro global-config remove-plugin [pluginName] -# 添加全局插件集 -$ taro global-config add-preset [presetName] -# 删除全局插件集 -$ taro global-config remove-preset [presetName] -# 重置 .taro-global-config 文件夹 -$ taro global-config reset -``` - -举个例子，比如有一些自定义的模版源，如果直接执行 `taro init` 命令，在每次初始化时都得传入大量的参数才得以完成项目的初始化构建。这时候开发者可以自行开发一个自定义的初始化插件，如下： - -```typescript -const TEMPLATE_SOURCE = 'your template source' -export default (ctx: IPluginContext) => { - ctx.registerCommand({ - // 命令名 - name: 'custom-init', - optionsMap: { - '--name': '项目名称', - '--description': '项目描述', - }, - // 执行 taro custom-init --help 时输出的使用例子的信息 - synopsisList: ['taro custom-init --description '], - // 命令钩子 - async fn() { - const name = ctx?.runOpts?._[1] || ctx?._.name - const description = ctx?.runOpts?.options?.description - //使用 taro cli 内部命令插件已通过此方法暴露出来 - ctx.applyCliCommandPlugin(['init']) - ctx.applyPlugins({ - name: 'init', - opts: { - options: { - typescript: true, - templateSource: TEMPLATE_SOURCE, - css: 'none', - framework: 'react', - compiler: 'webpack5', - description: description, - projectName: name, - }, - }, - }) - }, - }) -} -``` - -之后，可以把该插件作为全局插件安装，假设该插件名为 taro-custom-init，运行： - -```bash -$ taro global-config add-plugin taro-custom-init -``` - -之后只需要运行以下命令，即可完成你的自定义 Taro 项目了： - -```bash -$ taro custom-init --description -``` diff --git a/versioned_docs/version-4.x/codebase-overview.md b/versioned_docs/version-4.x/codebase-overview.md deleted file mode 100644 index eea447c7aad7..000000000000 --- a/versioned_docs/version-4.x/codebase-overview.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Taro 仓库概览 ---- - -## 仓库组成 - -以下列表介绍了 Taro 由哪些 NPM 包所组成，以及每个包的功能。 - -### 基础 - -| 路径 | 描述 | -| ------------------------ | :------------------------------------------------ | -| `@tarojs/cli` | CLI 工具 | -| `@tarojs/service` | 插件化内核 | -| `@tarojs/taro-loader` | Webpack loaders | -| `@tarojs/helper` | 工具库，主要供 CLI、编译时使用 | -| `@tarojs/runner-utils` | 工具库，主要供小程序、H5 的编译工具使用 | -| `@tarojs/shared` | 工具库，主要供运行时使用 | -| `@tarojs/taro` | 暴露各端所需要的 Taro 对象 | -| `@tarojs/api` | 和各端相关的 Taro API | -| `babel-preset-taro` | Babel preset | -| `eslint-config-taro` | ESLint 规则 | -| `postcss-pxtransform` | PostCSS 插件，转换 `px` 为各端的自适应尺寸单位 | -| `postcss-html-transform` | PostCSS 插件，用于 HTML、小程序标签的类名相互转换 | - -### 小程序 - -| 路径 | 描述 | -| -------------------------------- | :------------------------------------------------ | -| `@tarojs/mini-runner` | 小程序编译工具，主要用于设置、调用 Webpack | -| `@tarojs/react` | 基于 `react-reconciler` 的小程序专用 React 渲染器 | -| `@tarojs/runtime` | 小程序运行时适配器核心 | -| `@tarojs/plugin-platform-weapp` | 微信小程序插件 | -| `@tarojs/plugin-platform-alipay` | 支付宝小程序插件 | -| `@tarojs/plugin-platform-swan` | 百度小程序插件 | -| `@tarojs/plugin-platform-tt` | 抖音小程序插件 | -| `@tarojs/plugin-platform-qq` | qq 小程序插件 | -| `@tarojs/plugin-platform-jd` | 京东小程序插件 | -| `@tarojs/plugin-html` | 支持使用 HTML 标签的插件 | -| `@tarojs/plugin-react-devtools` | 支持使用 React DevTools 的插件 | -| `@tarojs/extend` | 类似 jQuery 的库 | - -### H5 - -| 路径 | 描述 | -| -------------------------------- | :--------------------------------------- | -| `@tarojs/webpack-runner` | H5 编译工具，主要用于设置、调用 Webpack | -| `@tarojs/router` | H5 路由 | -| `@tarojs/taro-h5` | H5 端根据微信小程序规范实现的 API | -| `@tarojs/components` | H5 组件库（Web Components 版本） | -| `@tarojs/components-react` | H5 组件库（React 版本） | -| `babel-plugin-transform-taroapi` | Babel 插件，让 API 可以被 `tree-shaking` | -| `postcss-plugin-constparse` | PostCSS 插件，用于处理 `tabbar` 的高度 | - -### RN - -| 路径 | 描述 | -| --------------------------------------------------- | :------------------------------------------------------------------- | -| `@tarojs/components-rn` | RN 组件库 | -| `@tarojs/rn-runner` | RN 编译工具，主要用于设置、调用 metro | -| `@tarojs/rn-style-transformer` | RN 样式转换工具，让 RN 支持 sass、less、stylus、postcss | -| `@tarojs/rn-supporter` | RN 基础 metro 配置 | -| `@tarojs/rn-transformer` | RN 应用入口及页面转换工具，让 RN 支持 Taro 定义的 app 及 page config | -| `@tarojs/router-rn` | RN 路由 | -| `@tarojs/runtime-rn` | RN 运行时封装 | -| `@tarojs/taro-rn` | RN 端根据微信小程序规范实现的 API | -| `babel-plugin-transform-react-jsx-to-rn-stylesheet` | Babel 插件，让 jsx 支持 className 属性 | -| `taro-css-to-react-native` | 将 css 转为 RN 的 stylesheet | - -### 其它 - -| 路径 | 描述 | -| -------------------- | :--------------------------- | -| `@tarojs/taroize` | 小程序转 Taro 的编译器 | -| `@tarojs/with-weapp` | 小程序转 Taro 的运行时适配器 | diff --git a/versioned_docs/version-4.x/come-from-miniapp.mdx b/versioned_docs/version-4.x/come-from-miniapp.mdx deleted file mode 100644 index 30ec9600da28..000000000000 --- a/versioned_docs/version-4.x/come-from-miniapp.mdx +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: 从原生小程序迁移过来？ ---- - -import { ReactIcon, VueIcon } from '@site/static/icons' -import TabItem from '@theme/TabItem' -import Tabs from '@theme/Tabs' - -本篇将讲述 Taro 开发和原生小程序开发的主要差异。希望能帮助掌握原生小程序开发，但不太了解 Taro 的同学快速进行迁移。 - -## 全局变量 - -在使用 React/Vue 时，全局变量推荐使用 **React Redux**、**Vuex** 等状态管理工具进行管理。 - -而有时候一些从原生小程序转换过来的项目，会把全局变量挂载到 `app` 上，然后使用 `getApp()` 获取它们。改造为 **React Redux**、**Vuex** 等状态管理方式成本比较大。 - -对于这种模式，Taro 提供了一些兼容的手段： - -### React - -可以使用入口组件的 `taroGlobalData` 属性兼容这种写法： - -```jsx title="app.js" -class App extends Component { - // 设置全局变量 "x" - taroGlobalData = { - x: 1, - } - - // ... -} -``` - -```jsx title="index.js" -function Index() { - // 获取并使用全局变量 "x" - const app = Taro.getApp() - console.log(app.x) - - // ... -} -``` - -### Vue3 - -可以使用 Taro 提供的 Vue 插件 `setGlobalDataPlugin` 兼容这种写法： - -```jsx title="app.js" -// 使用插件，设置全局变量 "x" -import { createApp } from 'vue' -import { setGlobalDataPlugin } from '@tarojs/taro' - -const App = createApp(...) -App.use(setGlobalDataPlugin, { - x: 1 -}) -``` - -```html title="index.vue" - -``` - -## API 的 scope - -在原生小程序开发中，在自定义组件中调用一些 API，如 `createCanvasContext`、`createSelectorQuery` 等时，需要传入指向自定义组件自身的 `this`，这里暂且称为 `scope`。 - -但是 Taro 3 使用 `