@ray-js/api 1.7.69 → 1.7.71

package/lib/BaseKit-3.17.7.js

@@ -2,127 +2,846 @@
 
 import { createFactory } from './utils';
 const factory = createFactory('BaseKit');
+
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const stopAccelerometer = factory('stopAccelerometer');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const startAccelerometer = factory('startAccelerometer');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getAudioFileDuration = factory('getAudioFileDuration');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const authorize = factory('authorize');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const authorizeStatus = factory('authorizeStatus');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const navigateToMiniProgram = factory('navigateToMiniProgram');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const startCompass = factory('startCompass');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const stopCompass = factory('stopCompass');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const startDeviceMotionListening = factory('startDeviceMotionListening');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const stopDeviceMotionListening = factory('stopDeviceMotionListening');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const startGyroscope = factory('startGyroscope');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const stopGyroscope = factory('stopGyroscope');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const chooseImage = factory('chooseImage');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const chooseMedia = factory('chooseMedia');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const chooseCropImage = factory('chooseCropImage');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const previewImage = factory('previewImage');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getImageInfo = factory('getImageInfo');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getVideoInfo = factory('getVideoInfo');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const saveVideoToPhotosAlbum = factory('saveVideoToPhotosAlbum');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const showToast = factory('showToast');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const showModal = factory('showModal');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const showLoading = factory('showLoading');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const showActionSheet = factory('showActionSheet');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const hideToast = factory('hideToast');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const hideLoading = factory('hideLoading');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const makePhoneCall = factory('makePhoneCall');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const setClipboardData = factory('setClipboardData');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getClipboardData = factory('getClipboardData');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const updateVolume = factory('updateVolume');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getCurrentVolume = factory('getCurrentVolume');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const registerSystemVolumeChange = factory('registerSystemVolumeChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const unRegisterSystemVolumeChange = factory('unRegisterSystemVolumeChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getSystemSetting = factory('getSystemSetting');
+/**
+ * @public
+ * @since @ray-js/ray 1.6.8
+ */
 export const getMobileDeviceInfo = factory('getDeviceInfo');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getSystemInfo = factory('getSystemInfo');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getSystemInfoSync = factory('getSystemInfoSync');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getWifiList = factory('getWifiList');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const getConnectedWifi = factory('getConnectedWifi');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const openSystemBluetoothSetting = factory('openSystemBluetoothSetting');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getNetworkType = factory('getNetworkType');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const setScreenBrightness = factory('setScreenBrightness');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getScreenBrightness = factory('getScreenBrightness');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const setKeepScreenOn = factory('setKeepScreenOn');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const vibrateShort = factory('vibrateShort');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const vibrateLong = factory('vibrateLong');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const scanCode = factory('scanCode');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const setStorage = factory('setStorage');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const setStorageSync = factory('setStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getStorage = factory('getStorage');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getStorageSync = factory('getStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const removeStorage = factory('removeStorage');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const removeStorageSync = factory('removeStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const clearStorage = factory('clearStorage');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const clearStorageSync = factory('clearStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const onSystemVolumeChangeEvent = factory('onSystemVolumeChangeEvent');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const offSystemVolumeChangeEvent = factory('offSystemVolumeChangeEvent');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const onGetWifiList = factory('onGetWifiList');
+/**
+ * @public
+ * @since @ray-js/ray 0.5.9
+ */
 export const offGetWifiList = factory('offGetWifiList');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onRecordingEvent = factory('onRecordingEvent');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offRecordingEvent = factory('offRecordingEvent');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onAccelerometerChange = factory('onAccelerometerChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offAccelerometerChange = factory('offAccelerometerChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onCompassChange = factory('onCompassChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offCompassChange = factory('offCompassChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onDeviceMotionChange = factory('onDeviceMotionChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offDeviceMotionChange = factory('offDeviceMotionChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onGyroscopeChange = factory('onGyroscopeChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offGyroscopeChange = factory('offGyroscopeChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onMemoryWarning = factory('onMemoryWarning');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offMemoryWarning = factory('offMemoryWarning');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onBluetoothAdapterStateChange = factory('onBluetoothAdapterStateChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offBluetoothAdapterStateChange = factory('offBluetoothAdapterStateChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const onNetworkStatusChange = factory('onNetworkStatusChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const offNetworkStatusChange = factory('offNetworkStatusChange');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const createInnerAudioContext = factory('createInnerAudioContext');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const downloadFile = factory('downloadFile');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getFileSystemManager = factory('getFileSystemManager');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const request = factory('request');
+/**
+ * @public
+ * @since @ray-js/ray 0.3.23
+ */
 export const getRecorderManager = factory('getRecorderManager');
+/**
+ * @public
+ * @since @ray-js/ray 0.6.5
+ */
 export const uploadFile = factory('uploadFile');
 // 3.2.1 新增 - 4.7.0 容器
+/**
+ * @public
+ * @since @ray-js/ray 0.8.0
+ */
 export const openMiniWidget = factory('openMiniWidget');
 
 // 3.3.10 新增 - 4.8.0 容器
+/**
+ * @public
+ * @since @ray-js/ray 1.4.57
+ */
 export const getCurrentVolumeByMode = factory('getCurrentVolumeByMode');
 
 // 3.11.0 新增 - 5.12.0
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const saveImageToPhotosAlbum = factory('saveImageToPhotosAlbum');
 
 // 3.14.3 新增
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const getSetting = factory('getSetting');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const getTempDirectory = factory('getTempDirectory');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const writeLogFile = factory('writeLogFile');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const getFileInfo = factory('getFileInfo');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const initializeUploadFile = factory('initializeUploadFile');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const uploadFileToDevice = factory('uploadFileToDevice');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const cancelUploadFileToDevice = factory('cancelUploadFileToDevice');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const compressImage = factory('compressImage');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const cropImages = factory('cropImages');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onUploadFileToDeviceStart = factory('onUploadFileToDeviceStart');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offUploadFileToDeviceStart = factory('offUploadFileToDeviceStart');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onUploadFileToDeviceProgress = factory('onUploadFileToDeviceProgress');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offUploadFileToDeviceProgress = factory('offUploadFileToDeviceProgress');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onUploadFileToDeviceComplete = factory('onUploadFileToDeviceComplete');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offUploadFileToDeviceComplete = factory('offUploadFileToDeviceComplete');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onUploadFileFragToDeviceProgress = factory('onUploadFileFragToDeviceProgress');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offUploadFileFragToDeviceProgress = factory('offUploadFileFragToDeviceProgress');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const cropImage = factory('cropImage');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const fetchImageThumbnail = factory('fetchImageThumbnail');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onKeyboardHeightChange = factory('onKeyboardHeightChange');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offKeyboardHeightChange = factory('offKeyboardHeightChange');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onKeyboardWillShow = factory('onKeyboardWillShow');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offKeyboardWillShow = factory('offKeyboardWillShow');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const onKeyboardWillHide = factory('onKeyboardWillHide');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.30
+ */
 export const offKeyboardWillHide = factory('offKeyboardWillHide');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.33
+ */
 export const fetchVideoThumbnails = factory('fetchVideoThumbnails');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.33
+ */
 export const clearVideoThumbnails = factory('clearVideoThumbnails');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.33
+ */
 export const clipVideo = factory('clipVideo');
+/**
+ * @public
+ * @since @ray-js/ray 1.5.35
+ */
 export const getAppAuthorizeSetting = factory('getAppAuthorizeSetting');
 
 // 3.17.7 新增
+/**
+ * @public
+ * @since @ray-js/ray 1.6.8
+ */
 export const authorizePolicy = factory('authorizePolicy');
+/**
+ * @public
+ * @since @ray-js/ray 1.6.8
+ */
 export const authorizePolicyStatus = factory('authorizePolicyStatus');
-export const showScanLogin = factory('showScanLogin');
+/**
+ * @public
+ * @since @ray-js/ray 1.6.8
+ */
+export const showScanLogin = factory('showScanLogin');
+
+// 3.30.1 新增
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const batchGetStorage = factory('batchGetStorage');
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const batchGetStorageSync = factory('batchGetStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const batchSetStorage = factory('batchSetStorage');
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const batchSetStorageSync = factory('batchSetStorageSync');
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const getStorageInfo = factory('getStorageInfo');
+/**
+ * @public
+ * @since @ray-js/ray 1.7.60
+ */
+export const getStorageInfoSync = factory('getStorageInfoSync');
+
+// FileSystemManager 子方法导出
+/**
+ * @public
+ * @alias FileSystemManager.access
+ */
+export const fileSystemManagerAccess = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.readFile
+ */
+export const fileSystemManagerReadFile = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.readFileSync
+ */
+export const fileSystemManagerReadFileSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.writeFile
+ */
+export const fileSystemManagerWriteFile = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.writeFileSync
+ */
+export const fileSystemManagerWriteFileSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.saveFile
+ */
+export const fileSystemManagerSaveFile = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.saveFileSync
+ */
+export const fileSystemManagerSaveFileSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.stat
+ */
+export const fileSystemManagerStat = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.statSync
+ */
+export const fileSystemManagerStatSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.mkdir
+ */
+export const fileSystemManagerMkdir = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.mkdirSync
+ */
+export const fileSystemManagerMkdirSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.rmdir
+ */
+export const fileSystemManagerRmdir = factory('getFileSystemManager');
+/**
+ * @public
+ * @public
+ * @alias FileSystemManager.rmdirSync
+ */
+export const fileSystemManagerRmdirSync = factory('getFileSystemManager');
+/**
+ * @public
+ * @alias FileSystemManager.removeSavedFile
+ */
+export const fileSystemManagerRemoveSavedFile = factory('getFileSystemManager');
+
+// InnerAudioContext 子方法导出
+/**
+ * @public
+ * @alias InnerAudioContext.pause
+ */
+export const innerAudioContextPause = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.resume
+ */
+export const innerAudioContextResume = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.play
+ */
+export const innerAudioContextPlay = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.seek
+ */
+export const innerAudioContextSeek = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.stop
+ */
+export const innerAudioContextStop = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.destroy
+ */
+export const innerAudioContextDestroy = factory('createInnerAudioContext');
+/**
+ * @public
+ * @public
+ * @alias InnerAudioContext.destroyPlayer
+ */
+export const innerAudioContextDestroyPlayer = factory('createInnerAudioContext');
+/**
+ * @public
+ * @alias InnerAudioContext.onTimeUpdate
+ */
+export const innerAudioContextOnTimeUpdate = factory('createInnerAudioContext');
+
+// DownloadTask 子方法导出
+/**
+ * @public
+ * @alias DownloadTask.abort
+ */
+export const downloadFileTaskAbort = factory('downloadFile');
+/**
+ * @public
+ * @alias DownloadTask.onHeadersReceived
+ */
+export const downloadFileTaskOnHeadersReceived = factory('downloadFile');
+/**
+ * @public
+ * @alias DownloadTask.offHeadersReceived
+ */
+export const downloadFileTaskOffHeadersReceived = factory('downloadFile');
+/**
+ * @public
+ * @alias DownloadTask.onProgressUpdate
+ */
+export const downloadFileTaskOnProgressUpdate = factory('downloadFile');
+/**
+ * @public
+ * @alias DownloadTask.offProgressUpdate
+ */
+export const downloadFileTaskOffProgressUpdate = factory('downloadFile');
+
+// UploadTask 子方法导出
+/**
+ * @public
+ * @alias UploadTask.abort
+ */
+export const uploadFileTaskAbort = factory('uploadFile');
+/**
+ * @public
+ * @alias UploadTask.onHeadersReceived
+ */
+export const uploadFileTaskOnHeadersReceived = factory('uploadFile');
+/**
+ * @public
+ * @alias UploadTask.offHeadersReceived
+ */
+export const uploadFileTaskOffHeadersReceived = factory('uploadFile');
+/**
+ * @public
+ * @alias UploadTask.onProgressUpdate
+ */
+export const uploadFileTaskOnProgressUpdate = factory('uploadFile');
+/**
+ * @public
+ * @alias UploadTask.offProgressUpdate
+ */
+export const uploadFileTaskOffProgressUpdate = factory('uploadFile');
+
+// RequestTask 子方法导出
+/**
+ * @public
+ * @alias RequestTask.abort
+ */
+export const requestTaskAbort = factory('request');
+/**
+ * @public
+ * @alias RequestTask.onHeadersReceived
+ */
+export const requestTaskOnHeadersReceived = factory('request');
+/**
+ * @public
+ * @alias RequestTask.offHeadersReceived
+ */
+export const requestTaskOffHeadersReceived = factory('request');
+
+// RecorderManager 子方法导出
+/**
+ * @public
+ * @alias RecorderManager.start
+ */
+export const recorderManagerStart = factory('getRecorderManager');
+/**
+ * @public
+ * @alias RecorderManager.resume
+ */
+export const recorderManagerResume = factory('getRecorderManager');
+/**
+ * @public
+ * @alias RecorderManager.pause
+ */
+export const recorderManagerPause = factory('getRecorderManager');
+/**
+ * @public
+ * @alias RecorderManager.stop
+ */
+export const recorderManagerStop = factory('getRecorderManager');
+/**
+ * @public
+ * @public
+ * @alias RecorderManager.startRecording
+ */
+export const recorderManagerStartRecording = factory('getRecorderManager');
+/**
+ * @public
+ * @public
+ * @alias RecorderManager.stopRecording
+ */
+export const recorderManagerStopRecording = factory('getRecorderManager');