mix-public 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/README.md +2 -0
  2. package/customMethod/cookie.js +12 -0
  3. package/customMethod/publicLogic.ts +1 -1
  4. package/docs/01./346/241/206/346/236/266/344/273/213/347/273/215/04./345/277/253/351/200/237/344/270/212/346/211/213.md +3 -2
  5. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/01.Goto.md +2 -0
  6. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/02.GotoMain.md +2 -0
  7. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/03.Drawer.md +2 -0
  8. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/04.PopupShow.md +2 -0
  9. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/05.GoBack.md +2 -0
  10. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/06.ReturnHomePage.md +2 -0
  11. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/01./351/241/265/351/235/242/350/267/263/350/275/254/07.GotoUrlByBrowse.md +2 -0
  12. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/02./347/211/271/346/256/212/351/241/265/351/235/242/350/267/263/350/275/254/01.GoToVideo.md +7 -2
  13. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/02./347/211/271/346/256/212/351/241/265/351/235/242/350/267/263/350/275/254/02.GoToMap.md +10 -3
  14. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/02./347/211/271/346/256/212/351/241/265/351/235/242/350/267/263/350/275/254/03.MapSearch.md +11 -3
  15. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/02./347/211/271/346/256/212/351/241/265/351/235/242/350/267/263/350/275/254/04.OnlineService.md +11 -3
  16. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/03./350/267/263/350/275/254/344/270/211/346/226/271/01.OpenOtherApp.md +15 -10
  17. package/docs/02.API/00./351/241/265/351/235/242/350/267/263/350/275/254/03./350/267/263/350/275/254/344/270/211/346/226/271/02.OpenWechatMiniProgram.md +17 -11
  18. package/docs/02.API/01./346/234/254/345/234/260/345/217/202/346/225/260/345/255/230/345/202/250/01.PutCookieInfo.md +48 -0
  19. package/docs/02.API/01./346/234/254/345/234/260/345/217/202/346/225/260/345/255/230/345/202/250/02.GetCookieInfo.md +44 -0
  20. package/docs/02.API/02.APP/345/210/206/344/272/253/01./345/210/206/344/272/253/351/223/276/346/216/245/350/207/263/345/276/256/344/277/241/01.ShareSessionUrl.md +11 -6
  21. package/docs/02.API/02.APP/345/210/206/344/272/253/01./345/210/206/344/272/253/351/223/276/346/216/245/350/207/263/345/276/256/344/277/241/02.ShareTimelineUrl.md +11 -6
  22. package/docs/02.API/02.APP/345/210/206/344/272/253/02./345/210/206/344/272/253/345/233/276/347/211/207/350/207/263/345/276/256/344/277/241/01.ShareSessionImage.md +8 -3
  23. package/docs/02.API/02.APP/345/210/206/344/272/253/02./345/210/206/344/272/253/345/233/276/347/211/207/350/207/263/345/276/256/344/277/241/02.Base64ImageShareWechatSession.md +8 -3
  24. package/docs/02.API/02.APP/345/210/206/344/272/253/02./345/210/206/344/272/253/345/233/276/347/211/207/350/207/263/345/276/256/344/277/241/03.ShareTimelineImage.md +8 -3
  25. package/docs/02.API/02.APP/345/210/206/344/272/253/02./345/210/206/344/272/253/345/233/276/347/211/207/350/207/263/345/276/256/344/277/241/04.Base64ImageShareWechatTimeline.md +8 -3
  26. package/docs/02.API/04.APP/345/233/276/347/211/207/01./345/233/276/347/211/207/351/200/211/346/213/251/01.UploadPhoto.md +17 -16
  27. package/docs/02.API/04.APP/345/233/276/347/211/207/01./345/233/276/347/211/207/351/200/211/346/213/251/02.LibraryPhoto.md +17 -16
  28. package/docs/02.API/04.APP/345/233/276/347/211/207/01./345/233/276/347/211/207/351/200/211/346/213/251/03.CameraPhoto.md +45 -0
  29. package/docs/api/BATCH_GENERATION_COMPLETE.md +28 -0
  30. package/docs/api/Cookie/346/223/215/344/275/234/017-PutCookieInfo.md +124 -0
  31. package/docs/api/Cookie/346/223/215/344/275/234/018-GetCookieInfo.md +141 -0
  32. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/015-OpenOtherApp.md +95 -0
  33. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/016-OpenWechatMiniProgram.md +107 -0
  34. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/032-JumpMiniApp.md +116 -0
  35. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/033-JumpHalfScreenApp.md +126 -0
  36. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/034-getMiniProgramUsageRecord.md +115 -0
  37. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/035-MiniAppDelete.md +86 -0
  38. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/046-OCRBankCard.md +131 -0
  39. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/047-OCRIdCard.md +170 -0
  40. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/048-ScanQRCode.md +113 -0
  41. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/049-QRCodeBase64.md +128 -0
  42. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/050-SetTitle.md +103 -0
  43. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/051-SetRightButtonTitle.md +112 -0
  44. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/052-SetStatusBarBgColor.md +110 -0
  45. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/053-SetStatusBarStyle.md +121 -0
  46. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/062-IsNet.md +133 -0
  47. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/064-GetApnsAuthorizationStatus.md +132 -0
  48. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/068-SettingApns.md +116 -0
  49. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/078-IsOpenPushSound.md +117 -0
  50. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/079-BindCloudChannel.md +137 -0
  51. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/080-UnbindCloudChannel.md +134 -0
  52. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/092-PhoneCall.md +131 -0
  53. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/094-FullScreen.md +87 -0
  54. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/104-OnlineService.md +128 -0
  55. package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/107-CutWord.md +136 -0
  56. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/019-ShareSessionUrl.md +106 -0
  57. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/020-ShareSessionImage.md +94 -0
  58. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/021-ShareTimelineUrl.md +107 -0
  59. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/022-ShareTimelineImage.md +95 -0
  60. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/023-Base64ImageShareWechatTimeline.md +99 -0
  61. package/docs/api//345/210/206/344/272/253/345/212/237/350/203/275/024-Base64ImageShareWechatSession.md +98 -0
  62. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/025-UploadPhoto.md +128 -0
  63. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/026-LibraryPhoto.md +129 -0
  64. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/027-CameraPhoto.md +129 -0
  65. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/028-SaveToSd.md +94 -0
  66. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/029-SaveBase64ImageToSd.md +99 -0
  67. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/030-CachePicture.md +115 -0
  68. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/031-PhotoBrowser.md +122 -0
  69. package/docs/api//345/233/276/347/211/207/345/244/204/347/220/206/093-SaveToiCloud.md +143 -0
  70. package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/013-GoToMap.md +83 -0
  71. package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/014-MapSearch.md +81 -0
  72. package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/063-GetLocation.md +173 -0
  73. package/docs/api//345/234/260/345/233/276/345/256/232/344/275/215/105-OpenAmap.md +151 -0
  74. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/010-LoginOut.md +77 -0
  75. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/036-ShowRewardedVideo.md +86 -0
  76. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/037-ShowInterstitial.md +88 -0
  77. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/056-SetBadgeValue.md +115 -0
  78. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/057-ClearBadgeValue.md +93 -0
  79. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/073-ClearAppCache.md +126 -0
  80. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/074-ExitApp.md +138 -0
  81. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/076-ReplaceAppIcon.md +131 -0
  82. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/082-SetApplicationIconBadgeNumber.md +137 -0
  83. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/083-ClearApplicationIconBadgeNumber.md +122 -0
  84. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/084-AutoLogin.md +118 -0
  85. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/096-InitCloudChannel.md +132 -0
  86. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/097-WeChatLogin.md +164 -0
  87. package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/098-QQLogin.md +168 -0
  88. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/004-Drawer.md +119 -0
  89. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/005-DrawerBack.md +70 -0
  90. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/006-PopupShow.md +103 -0
  91. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/007-PopupClose.md +71 -0
  92. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/044-RefreshDialog.md +88 -0
  93. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/085-ShowLoading.md +132 -0
  94. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/086-HideLoading.md +135 -0
  95. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/087-ShowMsg.md +135 -0
  96. package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/088-ShowDialog.md +159 -0
  97. package/docs/api//346/224/257/344/273/230/345/212/237/350/203/275/101-RequestAlipay.md +200 -0
  98. package/docs/api//346/224/257/344/273/230/345/212/237/350/203/275/102-RequestWechatPay.md +214 -0
  99. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/038-DownloadFiles.md +116 -0
  100. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/039-DownloadFileCancel.md +100 -0
  101. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/040-getDownloadFileProgress.md +129 -0
  102. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/041-DownloadFileDelete.md +103 -0
  103. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/042-FilesPreview.md +105 -0
  104. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/043-getFinishDownloadPaths.md +112 -0
  105. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/099-StartHttpServer.md +141 -0
  106. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/100-StopHttpServer.md +137 -0
  107. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/103-CacheSize.md +131 -0
  108. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/106-UploadVideo.md +132 -0
  109. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/109-PlayVideo.md +137 -0
  110. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/110-VideoDownload.md +137 -0
  111. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/111-StartAudioRecording.md +134 -0
  112. package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/112-StopAudioRecording.md +132 -0
  113. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/058-GetDeviceInfo.md +134 -0
  114. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/059-GetBrightness.md +104 -0
  115. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/060-GetVolume.md +105 -0
  116. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/065-Brightness.md +134 -0
  117. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/066-VolumeControl.md +142 -0
  118. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/069-GetAppVersion.md +118 -0
  119. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/070-GetStatusBarHeight.md +121 -0
  120. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/075-GetAppIconsPath.md +130 -0
  121. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/077-getBiometricRecognition.md +142 -0
  122. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/081-Shock.md +113 -0
  123. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/090-OpenGyro.md +121 -0
  124. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/091-CloseGyro.md +135 -0
  125. package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/095-Keyboard.md +136 -0
  126. package/docs/api//351/200/232/347/237/245/346/217/220/351/206/222/061-GetClipboardContent.md +117 -0
  127. package/docs/api//351/200/232/347/237/245/346/217/220/351/206/222/067-ScheduleReminder.md +138 -0
  128. package/docs/api//351/200/232/347/237/245/346/217/220/351/206/222/089-FloatingWindowData.md +168 -0
  129. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/001-Goto.md +114 -0
  130. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/002-GotoInside.md +80 -0
  131. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/003-GotoMain.md +70 -0
  132. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/008-GoBack.md +83 -0
  133. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/009-ReturnHomePage.md +84 -0
  134. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/011-GotoUrlByBrowse.md +81 -0
  135. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/012-GoToVideo.md +90 -0
  136. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/045-ReturnPageUrl.md +94 -0
  137. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/054-DestructionPage.md +93 -0
  138. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/055-PageCheck.md +94 -0
  139. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/071-GreyAllPages.md +129 -0
  140. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/072-ClosePop.md +133 -0
  141. package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/108-StayTime.md +139 -0
  142. package/main/mixappfunc.ts +703 -198
  143. package/main/paramsTypes.ts +10 -7
  144. package/mixRender.css +10 -11
  145. package/mixRender.js +9 -2
  146. package/package.json +1 -1
  147. package/docs/02.API/01./346/234/254/345/234/260/345/217/202/346/225/260/345/255/230/345/202/250/01.putCookieInfo.md +0 -29
  148. package/docs/02.API/01./346/234/254/345/234/260/345/217/202/346/225/260/345/255/230/345/202/250/02.getCookieInfo.md +0 -52
  149. package/docs/02.API/02.APP/345/210/206/344/272/253/_meta.json +0 -16
  150. package/docs/02.API/04.APP/345/233/276/347/211/207/01./345/233/276/347/211/207/351/200/211/346/213/251/03.CanemaPhoto.md +0 -44
  151. package/docs/02.API/04.APP/345/233/276/347/211/207/01./345/233/276/347/211/207/351/200/211/346/213/251/04.ImgUpload.md +0 -131
  152. package/docs/02.API/04.APP/345/233/276/347/211/207/_meta.json +0 -23
@@ -68,7 +68,6 @@ import type {
68
68
  JumpMiniAppRecordType,
69
69
  DownloadFileProgressRecordType,
70
70
  FinishDownloadPathsRecordType,
71
- RefreshDialogType,
72
71
  OCRBankCardType,
73
72
  OCRIdCardParamsType,
74
73
  OCRIdCardType,
@@ -99,8 +98,10 @@ import type {
99
98
  UploadVideoType,
100
99
  PlayVideoType,
101
100
  VideoDownloadType,
102
- StartAudioRecordingType
101
+ StartAudioRecordingType,
102
+ OnlineServiceType
103
103
  } from "./paramsTypes.ts"
104
+ import y from "../imageCut/exif-js.js";
104
105
 
105
106
  const loginUrl = "user-login";
106
107
  var u = navigator.userAgent;
@@ -176,9 +177,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
176
177
  },
177
178
  /**
178
179
  * 跳转页面
179
- * Url:跳转目标页面
180
- * 以http开头为跳转外部网页
181
- * MiniApp?MiniAppId=appid&OnlineUrl=onlineurl&JumpUrl=miniapppagename
180
+ * params: {
181
+ * Url: 跳转地址 string 必填
182
+ * Params: 跳转参数 object 非必填
183
+ * OutSide: 是否跳转浏览器打开页面(默认false) boolean 非必填
184
+ * }
185
+ * return: 无
186
+ * Explanation: 跳转页面(1. 外部网页跳转(http开头为跳转外部网页) 2. 站内小程序跳转(MiniApp?MiniAppId=appid&OnlineUrl=onlineurl&JumpUrl=miniapppagename) 3. APP注册页面跳转)
187
+ * USE: Goto({ Url: "", Params: {}, OutSide: false })
182
188
  * */
183
189
  Goto: function (op: GotoType = { Url: "", Params: {}, OutSide: false }): void {
184
190
  const Url: string = op.Url || "";
@@ -217,6 +223,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
217
223
  },
218
224
  /**
219
225
  * 跳转内部页面(内部方法)
226
+ * params: {
227
+ * Url: 页面路径 string 必填
228
+ * }
229
+ * return: 无
230
+ * Explanation: 跳转页面(内部方法,请使用Goto方法)
231
+ * USE: GotoInside({ Url: "" })
220
232
  * */
221
233
  GotoInside: function (op: GotoInsideType = { Url: "" }, Inside: boolean = false): void {
222
234
  if (!Inside) {
@@ -242,7 +254,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
242
254
  },
243
255
 
244
256
  /**
245
- * 跳转首页(仅用于登录页面)跳转页面为配置下标为0的页面
257
+ * 跳转首页
258
+ * params: 无
259
+ * return: 无
260
+ * Explanation: 仅用于登录页面,跳转页面为配置下标为0的首页
261
+ * USE: GotoMain()
246
262
  * */
247
263
  GotoMain: function (): void {
248
264
  callMethod({
@@ -259,7 +275,18 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
259
275
 
260
276
  /**
261
277
  * 抽屉效果
262
- * AnimationDirection 1:左,2:上,3:右,4:下
278
+ * params: {
279
+ * Url: 跳转URL string 必填
280
+ * ClickClose: 点击空白区域是否关闭(1:关闭 0:不关闭,默认0) number 非必填
281
+ * Width: 抽屉宽度(取值范围:0-1,默认0.8) number | string 非必填
282
+ * Height: 抽屉高度(取值范围:0-1,默认0.8) number | string 非必填
283
+ * AnimationDirection: 抽屉展示方向(1:左,2:上,3:右,4:下,默认1) number 非必填
284
+ * Duration: 展开关闭时间(ms,默认500) number 非必填
285
+ * MaskColor: 背景遮罩颜色(透明度在前的十六进制透明色,默认#33FFFFFF) string 非必填
286
+ * }
287
+ * return: 无
288
+ * Explanation: 以抽屉效果打开新页面
289
+ * USE: PublicLib.Drawer({ Url:'index', ClickClose: 1, Width:'0.8', Height:'0.8', AnimationDirection: 1, Duration:'600', MaskColor:'#33FFD700' })
263
290
  * */
264
291
  Drawer: function (op: DrawerType = { Url: "", ClickClose: 0, Width: '0.8', Height: '0.8', AnimationDirection: 1, Duration: '500', MaskColor: '#33ffff00' }): void {
265
292
  if (!op.Url) throw new Error("PARAM URL IS Necessary");
@@ -298,6 +325,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
298
325
 
299
326
  /**
300
327
  * 关闭抽屉
328
+ * params: 无
329
+ * return: 无
330
+ * Explanation: 关闭由Drawer方法打开的抽屉
331
+ * USE: DrawerBack()
301
332
  * */
302
333
  DrawerBack: function (): void {
303
334
  callMethod({
@@ -311,7 +342,17 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
311
342
  },
312
343
 
313
344
  /**
314
- * APP遮罩层
345
+ * 以弹窗显示打开页面
346
+ * params: {
347
+ * Url: 跳转URL string 必填
348
+ * ClickClose: 点击空白区域是否关闭(1:关闭 0:不关闭,默认0) number 非必填
349
+ * Width: 弹窗宽度(取值范围:0-1,默认0.7) number | string 非必填
350
+ * Height: 弹窗高度(取值范围:0-1,默认0.5) number | string 非必填
351
+ * MaskColor: 背景遮罩颜色(不带#的十六进制透明色,默认#33FFFFFF) string 非必填
352
+ * }
353
+ * return: 无
354
+ * Explanation: 以弹窗显示打开新页面
355
+ * USE: PublicLib.PopupShow({ Url:'index', ClickClose: 1, Width:'0.8', Height:'0.5', MaskColor:'#33FFD700' })
315
356
  * */
316
357
  PopupShow: function (op: PopupShowType = { Url: "", ClickClose: 0, Width: '0.8', Height: '0.8', MaskColor: '#33ffff00' }): void {
317
358
  if (!op.Url) throw new Error("PARAM URL IS Necessary");
@@ -344,6 +385,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
344
385
 
345
386
  /**
346
387
  * 关闭遮罩层
388
+ * params: 无
389
+ * return: 无
390
+ * Explanation: 关闭由PopupShow方法打开的弹窗
391
+ * USE: PopupClose()
347
392
  * */
348
393
  PopupClose: function (): void {
349
394
  callMethod({
@@ -357,10 +402,16 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
357
402
  },
358
403
 
359
404
  /**
360
- * 返回
405
+ * 返回页面
406
+ * params: {
407
+ * Level: 返回层级(1:返回上一页 2:返回上两页,以此类推) number 必填
408
+ * }
409
+ * return: 无
410
+ * Explanation: 返回至对应索引的首页并清空页面栈
411
+ * USE: GoBack({ Level: 1 })
361
412
  * */
362
- GoBack: function (op: GoBackType = { Level: '1' }): void {
363
- const Level = op.Level || "1";
413
+ GoBack: function (op: GoBackType = { Level: 1 }): void {
414
+ const Level = op.Level || 1;
364
415
  callMethod({
365
416
  environment: this.environment,
366
417
  methodName: "GoBack",
@@ -375,7 +426,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
375
426
 
376
427
  /**
377
428
  * 回到根页面
378
- * parameter: String(num)
429
+ * params: {
430
+ * Index: 配置的首页索引 number 必填
431
+ * }
432
+ * return: 无
433
+ * Explanation: 返回至对应索引的首页并清空页面栈
434
+ * USE: ReturnHomePage({ Index: 0 })
379
435
  * */
380
436
  ReturnHomePage: function (op: ReturnHomePageType = { Index: 0 }): void {
381
437
  const Index = op.Index || 0;
@@ -398,7 +454,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
398
454
  },
399
455
 
400
456
  /**
401
- * 退出APP至登录页面方法
457
+ * 退出APP至登录页面
458
+ * params: 无
459
+ * return: 无
460
+ * Explanation: 打退出APP至登录页面
461
+ * USE: LoginOut()
402
462
  * */
403
463
  LoginOut: function (): void {
404
464
  callMethod({
@@ -413,7 +473,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
413
473
 
414
474
  /*
415
475
  * 跳转至浏览器页面
416
- * params: (线上地址)
476
+ * params: {
477
+ * Url: 线上页面地址 string 必填
478
+ * }
479
+ * return: 无
480
+ * Explanation: 打开浏览器并加载线上页面
481
+ * USE: GotoUrlByBrowse({ Url: "" })
417
482
  */
418
483
  GotoUrlByBrowse: function (op: GotoInsideType = { Url: "" }): void {
419
484
  const Url = op.Url || "";
@@ -428,11 +493,18 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
428
493
  },
429
494
 
430
495
  /**
431
- * 跳转video页面
496
+ * 跳转页面并播放video
497
+ * params: {
498
+ * Url: 页面地址 string 必填
499
+ * VideoUrl: 视频地址 string 必填
500
+ * }
501
+ * return: 无
502
+ * Explanation: 跳转页面并插入视频播放,web只做视频播放
503
+ * USE: GoToVideo({ Url: "", VideoUrl: "" })
432
504
  * */
433
- GoToVideo: function (op: GoToVideoType & GotoInsideType = { Url: "", VideoUrls: "" }): void {
505
+ GoToVideo: function (op: GoToVideoType & GotoInsideType = { Url: "", VideoUrl: "" }): void {
434
506
  const Url = op.Url || "";
435
- const VideoUrls = op.VideoUrls || "";
507
+ const VideoUrls = op.VideoUrl || "";
436
508
  callMethod({
437
509
  environment: this.environment,
438
510
  methodName: "GoToVideo",
@@ -444,7 +516,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
444
516
  },
445
517
 
446
518
  /**
447
- * 跳转地图
519
+ * 跳转页面并插入地图
520
+ * params: {
521
+ * Url: 页面地址 string 必填
522
+ * }
523
+ * return: 无
524
+ * Explanation: 跳转页面并插入高德地图做关键词搜索,web只做页面跳转
525
+ * USE: GoToMap({ Url: "" })
448
526
  * */
449
527
  GoToMap: function (op: GotoInsideType = { Url: "" }): void {
450
528
  const Url = op.Url || "";
@@ -459,7 +537,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
459
537
  },
460
538
 
461
539
  /**
462
- * 地图搜索
540
+ * 跳转高德地图且做关键字搜索
541
+ * params: {
542
+ * KeyWord: 地图搜索关键词 string 必填
543
+ * }
544
+ * return: 无
545
+ * Explanation: 跳转高德地图做关键词搜索,web只跳转高德地图
546
+ * USE: MapSearch({ KeyWord: "" })
463
547
  * */
464
548
  MapSearch: function (op: MapSearchType = { KeyWord: "" }): void {
465
549
  const KeyWord = op.KeyWord || "";
@@ -475,6 +559,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
475
559
 
476
560
  /**
477
561
  * 打开其他APP
562
+ * params: {
563
+ * Url: 跳转其他app所需参数 string 必填
564
+ * }
565
+ * return: Promise<string> 打开失败会执行resolve
566
+ * Explanation: 跳转其他App
567
+ * USE: OpenOtherApp({ Url: "" })
478
568
  * */
479
569
  OpenOtherApp: function (op: GotoInsideType = { Url: "" }): Promise<string> {
480
570
  const Url = op.Url || "";
@@ -483,7 +573,7 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
483
573
  methodName: "OpenOtherApp",
484
574
  webMethod: () => {
485
575
  return new Promise((resolve, reject) => {
486
- window.location.href = Url;
576
+ // window.location.href = Url;
487
577
  setTimeout(() => {
488
578
  resolve("");
489
579
  }, 4000);
@@ -500,6 +590,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
500
590
 
501
591
  /**
502
592
  * 打开微信小程序
593
+ * params: {
594
+ * MiniProgramId: 微信小程序原始id string 必填
595
+ * APPId: 微信小程序appid string 必填
596
+ * Path: 微信小程序所需url string 必填
597
+ * }
598
+ * return: Promise<string> 打开失败会执行resolve
599
+ * Explanation: 跳转微信APP并打开微信小程序
600
+ * USE: OpenWechatMiniProgram({ MiniProgramId: "", APPId: "", Path: "" })
503
601
  * */
504
602
  OpenWechatMiniProgram: function (op: OpenWechatMiniProgramType = { MiniProgramId: "", APPId: "", Path: "" }): Promise<string> {
505
603
  const UserName = op.MiniProgramId || "";
@@ -632,6 +730,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
632
730
 
633
731
  /**
634
732
  * 分享链接到微信好友
733
+ * params: {
734
+ * Title: 微信链接标题 string 必填
735
+ * Detail: 微信链接详情 string 必填
736
+ * Icon: 微信链接图标 string 必填
737
+ * Url: 链接地址 string 必填
738
+ * }
739
+ * return: 无
740
+ * Explanation: 分享链接到微信好友(以卡片的形式)
741
+ * USE: ShareSessionUrl({ Title: "", Detail: "", Icon: "", Url: "" })
635
742
  * */
636
743
  ShareSessionUrl: function (op: ShareUrlType = { Title: "", Detail: "", Icon: "", Url: "" }): void {
637
744
  const Title = op.Title || "";
@@ -654,6 +761,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
654
761
 
655
762
  /**
656
763
  * 分享在线图片到微信好友
764
+ * params: {
765
+ * PicturePath: 在线图片路径 string 必填
766
+ * }
767
+ * return: 无
768
+ * Explanation: 分享在线图片到微信好友
769
+ * USE: ShareSessionImage({ PicturePath: "" })
657
770
  * */
658
771
  ShareSessionImage: function (op: SharPicType = { PicturePath: "" }): void {
659
772
  const PicturePath = op.PicturePath || "";
@@ -673,6 +786,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
673
786
 
674
787
  /**
675
788
  * 分享链接到微信微信朋友圈
789
+ * params: {
790
+ * PicturePath: 在线图片路径 string 必填
791
+ * }
792
+ * return: 无
793
+ * Explanation: 分享在线图片到微信朋友圈
794
+ * USE: ShareTimelineUrl({ PicturePath: "" })
676
795
  * */
677
796
  ShareTimelineUrl: function (op: ShareUrlType = { Title: "", Detail: "", Icon: "", Url: "" }): void {
678
797
  const Title = op.Title || "";
@@ -696,6 +815,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
696
815
 
697
816
  /**
698
817
  * 分享图片到微信朋友圈
818
+ * params: {
819
+ * PicturePath: 在线图片路径 string 必填
820
+ * }
821
+ * return: 无
822
+ * Explanation: 分享在线图片到微信朋友圈
823
+ * USE: ShareTimelineImage({ PicturePath: "" })
699
824
  * */
700
825
  ShareTimelineImage: function (op: SharPicType = { PicturePath: "" }): void {
701
826
  const PicturePath = op.PicturePath || "";
@@ -715,6 +840,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
715
840
 
716
841
  /**
717
842
  * 分享base64图片文件到朋友圈
843
+ * params: {
844
+ * Base64: 图片base64文件 string 必填
845
+ * }
846
+ * return: 无
847
+ * Explanation: 分享base64图片文件到微信朋友圈
848
+ * USE: Base64ImageShareWechatTimeline({ Base64: "" })
718
849
  * */
719
850
  Base64ImageShareWechatTimeline: function (op: SharBase64PicType = { Base64: "" }): void {
720
851
  const Base64 = op.Base64 || "";
@@ -734,6 +865,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
734
865
 
735
866
  /**
736
867
  * 分享base64图片文件到微信好友
868
+ * params: {
869
+ * Base64: 图片base64文件 string 必填
870
+ * }
871
+ * return: 无
872
+ * Explanation: 分享base64图片文件到微信好友
873
+ * USE: Base64ImageShareWechatSession({ Base64: "" })
737
874
  * */
738
875
  Base64ImageShareWechatSession: function (op: SharBase64PicType = { Base64: "" }): void {
739
876
  const Base64 = op.Base64 || "";
@@ -752,13 +889,17 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
752
889
  },
753
890
 
754
891
  /**
755
- * 选择图片(唤起相机或相册)
756
- * 多张图片调用MethodName回传图片数组
757
- * IOS base64
758
- * android 图片路径
892
+ * 选择图片(唤起相机或相册)
893
+ * params: {
894
+ * isCut: 是否裁剪 boolean 必填
895
+ * Quality: 质量(0-1) number 必填
896
+ * }
897
+ * return: Promise<file>
898
+ * Explanation: 调用相机或相册并返回拍摄或选择的图片文件对象
899
+ * USE: UploadPhoto({ isCut: false, Quality: 1 })
759
900
  * */
760
- UploadPhoto: function (op: SelectPhotoType = { PhotoCount: 1, isCut: false, Quality: 1 }): Promise<object> {
761
- const PhotoCount = op.PhotoCount || 1;
901
+ UploadPhoto: function (op: SelectPhotoType = { isCut: false, Quality: 1 }): Promise<object> {
902
+ const PhotoCount = 1;
762
903
  const isCut = op.isCut || false;
763
904
  const Quality = op.Quality || 1;
764
905
  return asyncReturnMethod({
@@ -789,13 +930,17 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
789
930
  },
790
931
 
791
932
  /**
792
- * 相册选择图片
793
- * 多张图片调用MethodName回传图片数组
794
- * IOS base64
795
- * android 图片路径
933
+ * 相册选择图片
934
+ * params: {
935
+ * isCut: 是否裁剪 boolean 必填
936
+ * Quality: 质量(0-1) number 必填
937
+ * }
938
+ * return: Promise<file>
939
+ * Explanation: 调用相册并返回选择的图片文件对象
940
+ * USE: LibraryPhoto({ isCut: false, Quality: 1 })
796
941
  * */
797
- LibraryPhoto: function (op: SelectPhotoType = { PhotoCount: 1, isCut: false, Quality: 1 }): Promise<object> {
798
- const PhotoCount = op.PhotoCount || 1;
942
+ LibraryPhoto: function (op: SelectPhotoType = { isCut: false, Quality: 1 }): Promise<object> {
943
+ const PhotoCount = 1;
799
944
  const isCut = op.isCut || false;
800
945
  const Quality = op.Quality || 1;
801
946
  return asyncReturnMethod({
@@ -826,13 +971,17 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
826
971
  },
827
972
 
828
973
  /**
829
- * 相机选择图片
830
- * 多张图片调用MethodName回传图片数组
831
- * IOS base64
832
- * android 图片路径
974
+ * 相机拍摄图片
975
+ * params: {
976
+ * isCut: 是否裁剪 boolean 必填
977
+ * Quality: 质量(0-1) number 必填
978
+ * }
979
+ * return: Promise<file>
980
+ * Explanation: 调用相机拍照并返回拍摄的图片文件对象
981
+ * USE: CameraPhoto({ isCut: false, Quality: 1 })
833
982
  * */
834
- CameraPhoto: function (op: SelectPhotoType = { PhotoCount: 1, isCut: false, Quality: 1 }): Promise<object> {
835
- const PhotoCount = op.PhotoCount || 1;
983
+ CameraPhoto: function (op: SelectPhotoType = { isCut: false, Quality: 1 }): Promise<object> {
984
+ const PhotoCount = 1;
836
985
  const isCut = op.isCut || false;
837
986
  const Quality = op.Quality || 1;
838
987
  return asyncReturnMethod({
@@ -863,7 +1012,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
863
1012
  },
864
1013
 
865
1014
  /**
866
- * 保存在线图片至SD
1015
+ * 保存在线图片
1016
+ * params: {
1017
+ * PicPath: 在线图片路径 string 必填
1018
+ * }
1019
+ * return: 无
1020
+ * Explanation: 保存在线图片至相册
1021
+ * USE: SaveToSd({ PicPath: "" })
867
1022
  * */
868
1023
  SaveToSd: function (op: SavePicType = { PicPath: "" }): void {
869
1024
  const PicPath = op.PicPath || "";
@@ -878,7 +1033,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
878
1033
  },
879
1034
 
880
1035
  /**
881
- * 保存base64图片至SD
1036
+ * 保存base64图片
1037
+ * params: {
1038
+ * Base64: 图片base64文件 string 必填
1039
+ * }
1040
+ * return: 无
1041
+ * Explanation: 保存base64图片至相册
1042
+ * USE: SaveBase64ImageToSd({ Base64: "" })
882
1043
  * */
883
1044
  SaveBase64ImageToSd: function (op: SharBase64PicType = { Base64: "" }): void {
884
1045
  const Base64 = op.Base64 || "";
@@ -894,6 +1055,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
894
1055
 
895
1056
  /**
896
1057
  * 图片缓存
1058
+ * params: {
1059
+ * PicUrl: 图片路径 string 必填
1060
+ * Domid: 元素ID string 必填
1061
+ * }
1062
+ * return: string
1063
+ * Explanation: 图片缓存,已缓存的图片不再进行网络请求
1064
+ * USE: <img id="CachePicture({ PicUrl: "图片路径", Domid: "cachePic" })" id="cachePic" src="xxxx" />
897
1065
  * */
898
1066
  CachePicture: function (op: CachePictureType = { PicUrl: "", Domid: "" }): string {
899
1067
  const Picurl = op.PicUrl || "";
@@ -912,6 +1080,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
912
1080
 
913
1081
  /**
914
1082
  * 图片预览放大、缩小(多张)TODO
1083
+ * params: {
1084
+ * Index: 预览图片下标 string 必填
1085
+ * ImageList: 图片列表 Array<string> 必填
1086
+ * }
1087
+ * return: 无
1088
+ * Explanation: 放大预览图片,web无此方法
1089
+ * USE: PhotoBrowser({ Index: 0, ImageList: [] })
915
1090
  * */
916
1091
  PhotoBrowser: function (op: PhotoBrowserType = { Index: 0, ImageList: [] }): void {
917
1092
  const Index = op.Index || 0;
@@ -932,6 +1107,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
932
1107
 
933
1108
  /**
934
1109
  * 跳转APP内小程序
1110
+ * params: {
1111
+ * OnlineUrl: web端小程序链接 string 非必填
1112
+ * MiniAppId: 小程序ID string 必填
1113
+ * JumpUrl: 跳转页面(不传则跳转配置的下标为0的首页)number 非必填
1114
+ * }
1115
+ * return: 无
1116
+ * Explanation: 以全屏的形式打开小程序,若不传OnlineUrl在web端则不跳转
1117
+ * USE: JumpMiniApp({ OnlineUrl: "", MiniAppId: "", JumpUrl: "" })
935
1118
  * */
936
1119
  JumpMiniApp: function (op: JumpMiniAppType = { OnlineUrl: "", MiniAppId: "", JumpUrl: "" }): void {
937
1120
  const OnlineUrl = op.OnlineUrl || "";
@@ -972,9 +1155,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
972
1155
 
973
1156
  /**
974
1157
  * 跳转本地半屏小程序
975
- * parameter:
976
- * ParentId(全屏小程序ID、选填)
977
- * HalfScreenId(半屏小程序ID、必填)
1158
+ * params: {
1159
+ * OnlineUrl: web端小程序链接 string 非必填
1160
+ * ParentId: 全屏小程序ID string 非必填
1161
+ * HalfScreenId: 半屏小程序ID string 必填
1162
+ * Height: 半屏小程序高度 number 必填
1163
+ * }
1164
+ * return: 无
1165
+ * Explanation: 以全屏 + 半屏的形式打开小程序,若不传OnlineUrl在web端则不跳转
1166
+ * USE: JumpHalfScreenApp({ OnlineUrl: "", ParentId: "", HalfScreenId: "", Height: 0.8 })
978
1167
  * */
979
1168
  JumpHalfScreenApp: function (op: JumpHalfScreenAppType = { OnlineUrl: "", ParentId: "", HalfScreenId: "", Height: 0.8 }): void {
980
1169
  const OnlineUrl = op.OnlineUrl || "";
@@ -994,7 +1183,7 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
994
1183
  openRecord.push({
995
1184
  id: ParentId,
996
1185
  time: new Date().getTime(),
997
- name: "",
1186
+ name: "小程序名称",
998
1187
  imagePath: ""
999
1188
  });
1000
1189
  mixPublicLib({ isWeb, version }).PutCookieInfo({
@@ -1011,7 +1200,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1011
1200
 
1012
1201
  /**
1013
1202
  * 获取小程序打开历史
1014
- * parameter: 无
1203
+ * params: 无
1204
+ * return: Array<JumpMiniAppRecordType> { id: 小程序 id, time: 小程序打开时间, name: 小程序名称, imagePath: 小程序图标 }
1205
+ * Explanation: 清除本地所有小程序安装包(下次进入小程序需要重新下载)
1206
+ * USE: getMiniProgramUsageRecord()
1015
1207
  * */
1016
1208
  getMiniProgramUsageRecord: function (): Array<JumpMiniAppRecordType> {
1017
1209
  return syncReturnMethod({
@@ -1029,7 +1221,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1029
1221
  },
1030
1222
 
1031
1223
  /**
1032
- * 清除本地所有小程序缓存
1224
+ * 清除本地所有小程序
1225
+ * params: 无
1226
+ * return: 无
1227
+ * Explanation: 清除本地所有小程序安装包(下次进入小程序需要重新下载)
1228
+ * USE: MiniAppDelete()
1033
1229
  * */
1034
1230
  MiniAppDelete: function (): void {
1035
1231
  callMethod({
@@ -1048,7 +1244,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1048
1244
 
1049
1245
  /**
1050
1246
  * 激励广告
1051
- * (调用时弹出广告)
1247
+ * params: 无
1248
+ * return: 无
1249
+ * Explanation: 调用时弹出激励广告
1250
+ * USE: ShowRewardedVideo()
1052
1251
  * */
1053
1252
  ShowRewardedVideo: function (): void {
1054
1253
  callMethod({
@@ -1063,7 +1262,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1063
1262
 
1064
1263
  /**
1065
1264
  * 插屏广告
1066
- * (调用时弹出广告)
1265
+ * params: 无
1266
+ * return: 无
1267
+ * Explanation: 调用时弹出插屏广告
1268
+ * USE: ShowInterstitial()
1067
1269
  * */
1068
1270
  ShowInterstitial: function (): void {
1069
1271
  callMethod({
@@ -1078,13 +1280,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1078
1280
 
1079
1281
  /**
1080
1282
  * 文件下载
1081
- * op:
1082
- * [
1083
- * {
1084
- * "downloadUrl":"https://lf9-cdn-tos.mp4",
1085
- * "path":"mp4/xgplayer-demo-720p.mp4"
1086
- * }
1087
- * ]
1283
+ * params: Array<DownloadFilesType> { downloadUrl: 资源下载地址, path: 下载文件名 } Array 必填
1284
+ * return: 无
1285
+ * Explanation: 下载文件
1286
+ * USE: DownloadFiles([{ downloadUrl:"https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }])
1088
1287
  * */
1089
1288
  DownloadFiles: function (op: Array<DownloadFilesType> = []): void {
1090
1289
  const List =
@@ -1107,11 +1306,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1107
1306
 
1108
1307
  /**
1109
1308
  * 取消文件下载
1110
- * op:
1111
- * [
1112
- * "https://lf9-cdn-tos.mp4",
1113
- * "https://lf9-cdn-tos.mp4"
1114
- * ]
1309
+ * params: Array<string> 文件路径 Array 必填
1310
+ * return: 无
1311
+ * Explanation: 取消当前文件下载
1312
+ * USE: DownloadFileCancel(['https://lf9-cdn-tos.mp4'])
1115
1313
  * */
1116
1314
  DownloadFileCancel: function (op: Array<string> = []): void {
1117
1315
  const List = op || [];
@@ -1131,22 +1329,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1131
1329
 
1132
1330
  /**
1133
1331
  * 获取下载进度
1134
- * op:
1135
- * [
1136
- * {
1137
- * "downloadUrl":"https://lf9-cdn-tos.mp4",
1138
- * "path":"mp4getFinishDownloadPaths/xgplayer-demo-720p.mp4"
1139
- * }
1140
- * ]
1141
- *
1142
- * return:
1143
- * [
1144
- * {
1145
- * "url":"https://lf9-cdn-tos.mp4",
1146
- * "progress":"10"
1147
- * }
1148
- * ]
1149
- *
1332
+ * params: Array<DownloadFilesType> { downloadUrl: 资源下载地址, path: 下载文件名 } Array 必填
1333
+ * return: Array<DownloadFileProgressRecordType> { url: 下载文件名, progress: 下载进度 }
1334
+ * Explanation: 获取当前文件下载进度
1335
+ * USE: getDownloadFileProgress([{ downloadUrl:"https://lf9-cdn-tos.mp4", path: 'mp4/lf9-cdn-tos.mp4' }])
1150
1336
  * */
1151
1337
  getDownloadFileProgress: function (op: Array<DownloadFilesType> = [], progress = 10): Array<DownloadFileProgressRecordType> {
1152
1338
  const List =
@@ -1169,11 +1355,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1169
1355
 
1170
1356
  /**
1171
1357
  * 删除已完成下载
1172
- * op:
1173
- * [
1174
- * "mp4/lf9-cdn-tos.mp4",
1175
- * "mp4/lf9-cdn-tos.mp4"
1176
- * ]
1358
+ * params: Array<string> 文件路径 Array 必填
1359
+ * return: 无
1360
+ * Explanation: 删除文件
1361
+ * USE: DownloadFileDelete(['mp4/lf9-cdn-tos.mp4'])
1177
1362
  * */
1178
1363
  DownloadFileDelete: function (op: Array<string> = []): void {
1179
1364
  const List = op || [];
@@ -1193,11 +1378,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1193
1378
 
1194
1379
  /**
1195
1380
  * 文件预览
1196
- * op:
1197
- * [
1198
- * "mp4/lf9-cdn-tos.mp4",
1199
- * "mp4/lf9-cdn-tos.mp4"
1200
- * ]
1381
+ * params: Array<string> 文件路径 Array 必填
1382
+ * return: 无
1383
+ * Explanation: 预览文件
1384
+ * USE: FilesPreview(['mp4/lf9-cdn-tos.mp4'])
1201
1385
  * */
1202
1386
  FilesPreview: function (op: Array<string> = []): void {
1203
1387
  const List = op || [];
@@ -1217,10 +1401,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1217
1401
 
1218
1402
  /**
1219
1403
  * 获取本地下载列表
1220
- *
1221
- * result = [
1222
- * { path: "mp4/xgplayer-demo-720p.mp4", time: "2022-02-03 10:21:56" },
1223
- * ];
1404
+ * params: 无
1405
+ * return: Array<FinishDownloadPathsRecordType> { path: 文件路径, time: 下载时间 }
1406
+ * Explanation: 获取通过DownloadFiles方法下载的文件列表
1407
+ * USE: getFinishDownloadPaths()
1224
1408
  * */
1225
1409
  getFinishDownloadPaths: function (): Array<FinishDownloadPathsRecordType> {
1226
1410
  return syncReturnMethod({
@@ -1236,10 +1420,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1236
1420
  },
1237
1421
 
1238
1422
  /**
1239
- * 重新刷新webview页面(webview刷新)
1423
+ * 刷新页面
1424
+ * params: 无
1425
+ * return: 无
1426
+ * Explanation: 刷新当前页面
1427
+ * USE: RefreshDialog()
1240
1428
  * */
1241
- RefreshDialog: function (op: RefreshDialogType = { Hide: 0 }): void {
1242
- const Hide = op.Hide || 0;
1429
+ RefreshDialog: function (): void {
1430
+ const Hide = 1;
1243
1431
  callMethod({
1244
1432
  environment: this.environment,
1245
1433
  methodName: "RefreshDialog",
@@ -1252,6 +1440,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1252
1440
 
1253
1441
  /**
1254
1442
  * 获取当前APP页面路径
1443
+ * params: 无
1444
+ * return: string
1445
+ * Explanation: 返回当前页面的路径
1446
+ * USE: ReturnPageUrl()
1255
1447
  * */
1256
1448
  ReturnPageUrl: function (): string {
1257
1449
  const pageUrl = window.location.pathname
@@ -1273,15 +1465,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1273
1465
 
1274
1466
  /**
1275
1467
  * 银行卡OCR
1276
- * {
1277
- * Type: 3,
1278
- * BankCardNumber: "6230245124578541",
1279
- * BankCardExpire: "2024-10-23",
1280
- * BankCardIssuer: "",
1281
- * BankCardOrganization: "",
1282
- * BankCardType: "",
1283
- * BankCardImgBase64: "data:",
1284
- * }
1468
+ * params: 无
1469
+ * return: Promise<OCRBankCardType> { BankCardNumber: 银行卡号码, Type: 类型(1:身份证正面,2:身份证反面 BankCardIssuer: 持卡人姓名, BankCardType: 卡片类型, BankCardImgFile: 图像file文件, BankCardExpire: 过期时间(2099.12.31), BankCardOrganization: 归属地 }
1470
+ * Explanation: 调用相机进行银行卡OCR识别并返回识别出的信息,web无此方法
1471
+ * USE: OCRBankCard().then(res=>{})
1285
1472
  * */
1286
1473
  OCRBankCard: function (): Promise<OCRBankCardType> {
1287
1474
  return asyncReturnMethod({
@@ -1327,17 +1514,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1327
1514
 
1328
1515
  /**
1329
1516
  * 身份证OCR
1330
- * {
1331
- * IdCardNumber: "51382219940929720x",
1332
- * Type,
1333
- * IdCardName: "张xx",
1334
- * IdCardAddress: "四川省眉山市仁寿县xxxxxxxx",
1335
- * IdCardImgBase64: img,
1336
- * IdCardValidDate: "2021.12.31-2041.12.31",
1337
- * IdCardNation: "民族",
1338
- * IdCardSex: "0",
1339
- * IdCardAuthority: "仁寿县公安局",
1340
- * }
1517
+ * params: {
1518
+ * Type: 识别类型(1: 身份证正面 2: 身份证反面) number 必填
1519
+ * }
1520
+ * return: Promise<OCRIdCardType> { IdCardNumber: 身份证号码, Type: 类型(1:身份证正面,2:身份证反面), IdCardName: 姓名, IdCardAddress: 地址, BankCardImgFile: 图像file文件, IdCardValidDate: 有效期(2026.12.31-2099.12.31), IdCardNation: 名族, IdCardSex: 性别(识别可能不准确,请以身份证倒数第二位判断性别), IdCardAuthority: 归属地 }
1521
+ * Explanation: 调用相机进行身份证OCR识别并返回识别出的信息,web无此方法
1522
+ * USE: OCRIdCard({Type: 1}).then(res=>{})
1341
1523
  * */
1342
1524
  OCRIdCard: function (op: OCRIdCardParamsType = { Type: 1 }): Promise<OCRIdCardType> {
1343
1525
  const Type = op.Type || op || 1;
@@ -1387,7 +1569,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1387
1569
  },
1388
1570
 
1389
1571
  /**
1390
- * 扫码
1572
+ * 扫码
1573
+ * params: 无
1574
+ * return: Promise<string>
1575
+ * Explanation: 调用相机获选择相册图片进行二维码扫描并返回扫描内容
1576
+ * USE: ScanQRCode().then(res=>{})
1391
1577
  * */
1392
1578
  ScanQRCode: function (): Promise<string> {
1393
1579
  return asyncReturnMethod({
@@ -1412,6 +1598,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1412
1598
 
1413
1599
  /**
1414
1600
  * 扫描base64二维码
1601
+ * params: {
1602
+ * Base64: 需扫描的base64文件 string 必填
1603
+ * }
1604
+ * return: Promise<string>
1605
+ * Explanation: 扫描 base64 文件并返回扫描内容
1606
+ * USE: QRCodeBase64({ Base64: "" }).then(res=>{})
1415
1607
  * */
1416
1608
  QRCodeBase64: function (op: SharBase64PicType = { Base64: "" }): Promise<string> {
1417
1609
  const Base64 = op.Base64;
@@ -1450,6 +1642,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1450
1642
 
1451
1643
  /**
1452
1644
  * 设置APP标题栏文字
1645
+ * params: {
1646
+ * Title: 标题栏文字 string 必填
1647
+ * }
1648
+ * return: 无
1649
+ * Explanation: 设置当前页面的状态栏标题文字
1650
+ * USE: SetTitle({ Title: "" })
1453
1651
  * */
1454
1652
  SetTitle: function (op: SetTitleType = { Title: "" }): void {
1455
1653
  const Title = op.Title || "";
@@ -1467,6 +1665,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1467
1665
 
1468
1666
  /**
1469
1667
  * 设置标题栏右侧文字
1668
+ * params: {
1669
+ * ButtonTitle: 标题栏右侧文字 string 必填
1670
+ * FontSize: 标题栏右侧文字大小(px) string 必填
1671
+ * TitleColor: 标题栏右侧文字颜色(#ffffff) string 必填
1672
+ * }
1673
+ * return: 无
1674
+ * Explanation: 设置当前页面的状态栏右侧按钮文字及样式
1675
+ * USE: SetRightButtonTitle({ ButtonTitle: "", FontSize: "12", TitleColor: "#333333" })
1470
1676
  * */
1471
1677
  SetRightButtonTitle: function (op: SetRightButtonTitleType = { ButtonTitle: "", FontSize: "12", TitleColor: "#333333" }): void {
1472
1678
  const ButtonTitle = op.ButtonTitle || "";
@@ -1498,7 +1704,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1498
1704
  },
1499
1705
 
1500
1706
  /**
1501
- * 设置状态栏背景色
1707
+ * 设置状态栏背景色
1708
+ * params: {
1709
+ * BGColor: 状态栏背景颜色(#ffffff) string 必填
1710
+ * Index: 当前页面为配置的首页索引 number 非必填
1711
+ * }
1712
+ * return: 无
1713
+ * Explanation: 设置当前页面的状态栏背景颜色
1714
+ * USE: SetStatusBarBgColor({ BGColor: "", Index: 0 })
1502
1715
  * */
1503
1716
  SetStatusBarBgColor: function (op: SetStatusBarBgColorType = { BGColor: "", Index: 0 }): void {
1504
1717
  const BGColor = op.BGColor || "#ffffff";
@@ -1515,7 +1728,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1515
1728
  },
1516
1729
 
1517
1730
  /**
1518
- * 设置状态栏样式
1731
+ * 设置状态栏文字样式
1732
+ * params: {
1733
+ * Type: 状态栏样式类型(default:默认(深色) light:白色) string 必填
1734
+ * IsShow: 状态栏文字是否显示(1:显示 0:不显示) number 必填
1735
+ * Index: 当前页面为配置的首页索引 number 非必填
1736
+ * }
1737
+ * return: 无
1738
+ * Explanation: 设置当前页面的状态栏文字样式
1739
+ * USE: SetStatusBarStyle({ Type: "default", IsShow: 1, Index: 0 })
1519
1740
  * */
1520
1741
  SetStatusBarStyle: function (op: SetStatusBarStyleType = { Type: "default", IsShow: 1, Index: 0 }): void {
1521
1742
  const StatusBarStyle = op.Type || "default";
@@ -1535,16 +1756,19 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1535
1756
  },
1536
1757
 
1537
1758
  /**
1538
- * 退出关闭音频
1539
- * (渲染页面时调用,退出销毁webview)
1759
+ * 销毁页面
1760
+ * params: 无
1761
+ * return: 无
1762
+ * Explanation: 页面加载时调用,退出强制销毁webview
1763
+ * USE: DestructionPage()
1540
1764
  * */
1541
- PlayMusic: function (): void {
1765
+ DestructionPage: function (): void {
1542
1766
  callMethod({
1543
1767
  environment: this.environment,
1544
1768
  methodName: "PlayMusic",
1545
1769
  webMethod: () => {
1546
1770
  console.log(
1547
- `调用退出关闭音频,退出页面后关闭页面音频`,
1771
+ `调用退出销毁页面`,
1548
1772
  "color: blue",
1549
1773
  "color: #4CAF50;"
1550
1774
  );
@@ -1554,7 +1778,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1554
1778
  },
1555
1779
 
1556
1780
  /**
1557
- * 页面版本落后时,强制更新页面(webview刷新)
1781
+ * 检查页面更新
1782
+ * params: 无
1783
+ * return: 无
1784
+ * Explanation: 当页面版本落后时,会强制更新页面并刷新,web无此方法
1785
+ * USE: PageCheck()
1558
1786
  * */
1559
1787
  PageCheck: function (): void {
1560
1788
  callMethod({
@@ -1562,7 +1790,7 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1562
1790
  methodName: "PageCheck",
1563
1791
  webMethod: () => {
1564
1792
  console.log(
1565
- `当前页面有版本更新`,
1793
+ `检查页面更新`,
1566
1794
  "color: blue",
1567
1795
  "color: #4CAF50;"
1568
1796
  );
@@ -1573,6 +1801,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1573
1801
 
1574
1802
  /**
1575
1803
  * 设置消息数量
1804
+ * params: {
1805
+ * Index: 设置消息红点的首页页面索引 number 必填
1806
+ * Num: 设置消息红点的数量 number 必填
1807
+ * }
1808
+ * return: 无
1809
+ * Explanation: 设置对应索引的配置的首页消息红点
1810
+ * USE: SetBadgeValue({ Index: 1, Num: 1 })
1576
1811
  * */
1577
1812
  SetBadgeValue: function (op: SetBadgeValueType = { Index: 0, Num: 0 }): void {
1578
1813
  const Index = op.Index || 0;
@@ -1588,7 +1823,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1588
1823
  },
1589
1824
 
1590
1825
  /**
1591
- * 清除消息红点
1826
+ * 清除首页消息红点
1827
+ * params: {
1828
+ * Index: 清除消息红点的首页页面索引 number 必填
1829
+ * }
1830
+ * return: 无
1831
+ * Explanation: 清除对应索引的配置的首页消息红点
1832
+ * USE: ClearBadgeValue({Index: 1})
1592
1833
  * */
1593
1834
  ClearBadgeValue: function (op: ReturnHomePageType = { Index: 0 }): void {
1594
1835
  const Index = op.Index || 0;
@@ -1604,19 +1845,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1604
1845
 
1605
1846
  /**
1606
1847
  * 获取设备信息
1607
- * | Model | String | 型号 |
1608
- * | Brand | String | 品牌 |
1609
- * | Device | String | 设备 |
1610
- * | Version | String | Android 版本 |
1611
- * | SdkVersion | String | SDK 版本 |
1612
- * | Property | String | 内核 版本 |
1613
- * | DeviceId | String | 设备ID |
1614
- * | TotalSpace | String | 总存储空间大小 |
1615
- * | FreeSpace | String | 可用存储空间大小 |
1616
- * | BatteryPercentage | String | 电量 |
1617
- * | Connection | String | 网络类型 |
1618
- * | Country | String | 国家 |
1619
- * | Language | String | 语言 |
1848
+ * params:
1849
+ * return: Promise<GetDeviceInfoType> {Model: "型号", Brand: "品牌", Device: "设备", Version: "Android版本", SdkVersion: "SDK版本", Property: "内核版本", DeviceId: "设备ID" , TotalSpace: "总存储空间大小", FreeSpace: "可用存储空间大小", BatteryPercentage: "电量", Connection: "网络类型", Country: "国家", Language: "语言",}
1850
+ * Explanation: 获取当前设备信息
1851
+ * USE: GetDeviceInfo().then(res=>{})
1620
1852
  * */
1621
1853
  GetDeviceInfo: function (): Promise<GetDeviceInfoType> {
1622
1854
  return new Promise<GetDeviceInfoType>((resolve, reject) => {
@@ -1665,6 +1897,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1665
1897
 
1666
1898
  /**
1667
1899
  * 获取屏幕亮度
1900
+ * params: 无
1901
+ * return: number 0-1
1902
+ * Explanation: 获取当前设备屏幕亮度
1903
+ * USE: GetBrightness()
1668
1904
  * */
1669
1905
  GetBrightness: function (): number {
1670
1906
  return syncReturnMethod({
@@ -1679,6 +1915,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1679
1915
 
1680
1916
  /**
1681
1917
  * 获取音量大小
1918
+ * params: 无
1919
+ * return: number 0-1
1920
+ * Explanation: 获取当前设备音量大小
1921
+ * USE: GetVolume()
1682
1922
  * */
1683
1923
  GetVolume: function (): number {
1684
1924
  return syncReturnMethod({
@@ -1692,7 +1932,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1692
1932
  },
1693
1933
 
1694
1934
  /**
1695
- * 复制剪切板内容
1935
+ * 获取剪切板内容
1936
+ * params: 无
1937
+ * return: string
1938
+ * Explanation: 获取剪切板最新的一条内容
1939
+ * USE: GetClipboardContent()
1696
1940
  * */
1697
1941
  GetClipboardContent: function (): string {
1698
1942
  return syncReturnMethod({
@@ -1707,7 +1951,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1707
1951
 
1708
1952
  /**
1709
1953
  * 网络是否通畅
1710
- * void: "1"\"0"
1954
+ * params:
1955
+ * return: string '1': 网络正常 '0': 网络异常
1956
+ * Explanation: 检查当前设备网络是否通畅
1957
+ * USE: IsNet()
1711
1958
  **/
1712
1959
  IsNet: function (): string {
1713
1960
  return syncReturnMethod({
@@ -1722,8 +1969,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1722
1969
 
1723
1970
  /**
1724
1971
  * 获取定位信息
1972
+ * params: 无
1973
+ * return: Promise<GetLocationType> {latitude: '经度', longitude: '纬度'}
1974
+ * Explanation: 获取当前位置信息
1975
+ * USE: GetLocation().then(res=>{})
1725
1976
  * */
1726
- GetLocation: function (op = {}): Promise<GetLocationType> {
1977
+ GetLocation: function (): Promise<GetLocationType> {
1727
1978
  return asyncReturnMethod({
1728
1979
  environment: this.environment,
1729
1980
  methodName: "GetLocation",
@@ -1769,7 +2020,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1769
2020
 
1770
2021
  /**
1771
2022
  * 获取推送用户授权状态
1772
- * 返回值:0未授权 1已授权
2023
+ * params:
2024
+ * return: number 0: 未授权 1: 已授权
2025
+ * Explanation: 获取推送用户授权状态
2026
+ * USE: GetApnsAuthorizationStatus()
1773
2027
  * */
1774
2028
  GetApnsAuthorizationStatus: function (): number {
1775
2029
  return syncReturnMethod({
@@ -1784,7 +2038,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1784
2038
 
1785
2039
  /**
1786
2040
  * 调整屏幕亮度
1787
- * (参数范围:0-1)
2041
+ * params: {
2042
+ * Value: 亮度大小(参数范围:0-1) number 必填
2043
+ * }
2044
+ * return: 无
2045
+ * Explanation: 调整当前APP调整屏幕亮度,web无此方法
2046
+ * USE: Brightness({ Value: 0.8 })
1788
2047
  * */
1789
2048
  Brightness: function (op: BrightnessType = { Value: 0.8 }): void {
1790
2049
  const opValue = op.Value || 0.8;
@@ -1801,7 +2060,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1801
2060
 
1802
2061
  /**
1803
2062
  * 调整音量大小
1804
- * (参数范围:0-1)
2063
+ * params: {
2064
+ * Value: 音量大小(参数范围:0-1) number 必填
2065
+ * }
2066
+ * return: 无
2067
+ * Explanation: 调整当前APP音量大小,web无此方法
2068
+ * USE: VolumeControl({ Value: 0.8 })
1805
2069
  * */
1806
2070
  VolumeControl: function (op: BrightnessType = { Value: 0.8 }): void {
1807
2071
  const opValue = op.Value || 0.8;
@@ -1817,17 +2081,21 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1817
2081
  },
1818
2082
 
1819
2083
  /**
1820
- * 日历日程提醒
1821
- * parameter:
1822
- * Title(标题、必填、String)
1823
- * Notes(提示内容、必填、String)
1824
- * StartDate(开始时间、必填、Date)
1825
- * Alarm(提前时间(整分钟)、必填、Number)
2084
+ * 日历日程提醒
2085
+ * params: {
2086
+ * Title: 标题 string 必填
2087
+ * Notes: 提示内容 string 必填
2088
+ * StartDate: 开始时间 date 必填
2089
+ * Alarm: 提前时间(m) number 必填
2090
+ * }
2091
+ * return: 无
2092
+ * Explanation: 设置当前信息至日历日程提醒,web无此方法
2093
+ * USE: ScheduleReminder({ Title: "", Notes: "", StartDate: new Date(), Alarm: 0 })
1826
2094
  * */
1827
2095
  ScheduleReminder: function (op: ScheduleReminderType = { Title: "", Notes: "", StartDate: new Date(), Alarm: 0 }): void {
1828
2096
  const Title = op.Title || "";
1829
2097
  const Notes = op.Notes || "";
1830
- const StartDate = op.StartDate || "";
2098
+ const StartDate = Math.floor(op.StartDate.getTime() / 1000) || Math.floor(new Date().getTime() / 1000);
1831
2099
  const Alarm = op.Alarm || 0;
1832
2100
  callMethod({
1833
2101
  environment: this.environment,
@@ -1840,7 +2108,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1840
2108
  },
1841
2109
 
1842
2110
  /**
1843
- * 跳转当前系统APP设置界面
2111
+ * 跳转当前系统APP设置界面
2112
+ * params: 无
2113
+ * return: 无
2114
+ * Explanation: 跳转至当前系统APP设置界面,web无此方法
2115
+ * USE: SettingApns()
1844
2116
  * */
1845
2117
  SettingApns: function (): void {
1846
2118
  callMethod({
@@ -1855,6 +2127,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1855
2127
 
1856
2128
  /**
1857
2129
  * 获取APP版本号
2130
+ * params: 无
2131
+ * return: Promise<string>
2132
+ * Explanation: 返回当前APP版本号
2133
+ * USE: GetAppVersion()
1858
2134
  * */
1859
2135
  GetAppVersion: function (): Promise<string> {
1860
2136
  return new Promise((resolve, reject) => {
@@ -1883,6 +2159,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1883
2159
 
1884
2160
  /**
1885
2161
  * 获取APP顶部状态栏高度
2162
+ * params: 无
2163
+ * return: number (单位 px)
2164
+ * Explanation: 返回当前APP状态栏高度
2165
+ * USE: GetStatusBarHeight()
1886
2166
  * */
1887
2167
  GetStatusBarHeight: function (): number {
1888
2168
  return syncReturnMethod({
@@ -1897,7 +2177,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1897
2177
 
1898
2178
  /**
1899
2179
  * app灰色模式
1900
- * (登录页面时调用)
2180
+ * params: 无
2181
+ * return: 无
2182
+ * Explanation: 调整网页为灰色模式(未实现)
2183
+ * USE: GreyAllPages()
1901
2184
  * */
1902
2185
  GreyAllPages: function (): void {
1903
2186
  callMethod({
@@ -1911,7 +2194,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1911
2194
  },
1912
2195
 
1913
2196
  /**
1914
- * 关闭隐私协议弹窗
2197
+ * 关闭隐私协议弹窗
2198
+ * params: {
2199
+ * ReadType: 是否阅读隐私协议(0:未阅读 1:已阅读)number 必填
2200
+ * }
2201
+ * return: 无
2202
+ * Explanation: 关闭隐私协议弹窗,若未阅读下次进入APP时会显示
2203
+ * USE: ClosePop({ReadType: 0})
1915
2204
  * */
1916
2205
  ClosePop(op: ClosePopType = { ReadType: 0 }): void {
1917
2206
  const ReadType = op.ReadType || 0;
@@ -1935,6 +2224,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1935
2224
 
1936
2225
  /**
1937
2226
  * 清理APP缓存
2227
+ * params: 无
2228
+ * return: 无
2229
+ * Explanation: 清除当前APP的缓存,web清除cooikes 中的缓存
2230
+ * USE: ClearAppCache()
1938
2231
  * */
1939
2232
  ClearAppCache: function (): void {
1940
2233
  callMethod({
@@ -1962,6 +2255,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1962
2255
 
1963
2256
  /**
1964
2257
  * 退出APP
2258
+ * params: 无
2259
+ * return: 无
2260
+ * Explanation: 退出当前APP,web无此方法
2261
+ * USE: ExitApp()
1965
2262
  * */
1966
2263
  ExitApp: function (): void {
1967
2264
  callMethod({
@@ -1976,7 +2273,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1976
2273
 
1977
2274
  /**
1978
2275
  * 获取APP图标路径
1979
- * parameter: 无
2276
+ * params: 无
2277
+ * return: Array<string>
2278
+ * Explanation: 返回当前APP可使用的图标ID列表,web无此方法
2279
+ * USE: GetAppIconsPath()
1980
2280
  * */
1981
2281
  GetAppIconsPath: function (): Array<string> {
1982
2282
  return syncReturnMethod({
@@ -1991,7 +2291,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
1991
2291
 
1992
2292
  /**
1993
2293
  * 更换APP图标
1994
- * parameter:
2294
+ * params: {
2295
+ * Id: 更换的图标ID string 必填
2296
+ * }
2297
+ * return: 无
2298
+ * Explanation: 更换当前APP图标(需在OMEGA提前配置APP图标及图标ID),web无此方法
2299
+ * USE: ReplaceAppIcon({Id: 'changeIcon'})
1995
2300
  * */
1996
2301
  ReplaceAppIcon: function (op: ReplaceAppIconType = { Id: "" }): void {
1997
2302
  const Id = op.Id || "";
@@ -2007,7 +2312,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2007
2312
 
2008
2313
  /**
2009
2314
  * 生物识别
2010
- * 返回值:0未通过 1通过
2315
+ * params:
2316
+ * return: number
2317
+ * Explanation: 生物识别结果是否通过(0: 未通过 1: 通过),web无此方法
2318
+ * USE: getBiometricRecognition()
2011
2319
  * */
2012
2320
  getBiometricRecognition: function (): number {
2013
2321
  return syncReturnMethod({
@@ -2021,7 +2329,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2021
2329
  },
2022
2330
 
2023
2331
  /**
2024
- * 阿里云push推送音效
2332
+ * 阿里云push推送音效
2333
+ * params: {
2334
+ * IsOpen: 是否开启音效(1:开启 0: 不开启) number 必填
2335
+ * }
2336
+ * return: 无
2337
+ * Explanation: 开启阿里云push推送音效,web无此方法
2338
+ * USE: IsOpenPushSound({IsOpen: 0})
2025
2339
  * */
2026
2340
  IsOpenPushSound: function (op: IsOpenPushSoundType = { IsOpen: 0 }): void {
2027
2341
  const IsOpen = op.IsOpen || 0;
@@ -2040,7 +2354,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2040
2354
  },
2041
2355
 
2042
2356
  /**
2043
- * 绑定阿里云push账号
2357
+ * 绑定阿里云push账号
2358
+ * params: {
2359
+ * Account: 绑定账号 string 必填
2360
+ * }
2361
+ * return: 无
2362
+ * Explanation: 绑定阿里云push账号,web无此方法
2363
+ * USE: BindCloudChannel({Account: ""})
2044
2364
  * */
2045
2365
  BindCloudChannel: function (op: BindCloudChannelType = { Account: "" }): void {
2046
2366
  const Account = op.Account || "";
@@ -2059,7 +2379,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2059
2379
  },
2060
2380
 
2061
2381
  /**
2062
- * 解除阿里云push账号绑定
2382
+ * 解除阿里云push账号绑定
2383
+ * params: 无
2384
+ * return: 无
2385
+ * Explanation: 调用解除阿里云push账号绑定,web无此方法
2386
+ * USE: UnbindCloudChannel()
2063
2387
  * */
2064
2388
  UnbindCloudChannel: function (): void {
2065
2389
  callMethod({
@@ -2078,7 +2402,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2078
2402
 
2079
2403
  /**
2080
2404
  * 震动
2081
- * parameter: String(num)
2405
+ * params:
2406
+ * return: 无
2407
+ * Explanation: 调用系统震动,web 无此方法
2408
+ * USE: Shock()
2082
2409
  * */
2083
2410
  Shock: function (): void {
2084
2411
  callMethod({
@@ -2092,8 +2419,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2092
2419
  },
2093
2420
 
2094
2421
  /**
2095
- * 设置AppICON消息数量角标
2096
- * android 未实现
2422
+ * 设置APPICON角标数量
2423
+ * params: {
2424
+ * BadgeNum: 角标设置数量 number 必填
2425
+ * }
2426
+ * return: 无
2427
+ * Explanation: 设置APP图标的角标数值,安卓、web无此方法
2428
+ * USE: SetApplicationIconBadgeNumber({BadgeNum: 0})
2097
2429
  * */
2098
2430
  SetApplicationIconBadgeNumber: function (op: SetApplicationIconBadgeNumberType = { BadgeNum: 0 }): void {
2099
2431
  const BadgeNum = op.BadgeNum || 0;
@@ -2113,7 +2445,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2113
2445
 
2114
2446
  /**
2115
2447
  * 清除App消息数量角标
2116
- * android 未实现
2448
+ * params:
2449
+ * return: 无
2450
+ * Explanation: 清除APP图标的角标数值,安卓、web无此方法
2451
+ * USE: ClearApplicationIconBadgeNumber()
2117
2452
  * */
2118
2453
  ClearApplicationIconBadgeNumber: function (): void {
2119
2454
  callMethod({
@@ -2128,8 +2463,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2128
2463
 
2129
2464
  /**
2130
2465
  * 自动登录方法
2131
- * parameter:
2132
- * Url 自动登录跳转地址
2466
+ * params: {
2467
+ * Url: 自动登录跳转地址 string 必填
2468
+ * }
2469
+ * return: 无
2470
+ * Explanation: 调用开启自动登录,下次进入APP时自动跳转至对应页面,web无此方法
2471
+ * USE: AutoLogin({Url: "index"})
2133
2472
  * */
2134
2473
  AutoLogin: function (op: GotoInsideType = { Url: "" }): void {
2135
2474
  const Url = op.Url || "main";
@@ -2144,7 +2483,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2144
2483
  },
2145
2484
 
2146
2485
  /**
2147
- * 显示加载dialog
2486
+ * 显示加载dialog
2487
+ * params: {
2488
+ * Message: 加载框文字 string 必填
2489
+ * }
2490
+ * return: 无
2491
+ * Explanation: 调用打开加载框
2492
+ * USE: ShowLoading({Message: ""})
2148
2493
  * */
2149
2494
  ShowLoading: function (op: ShowLoadingType = { Message: "加载中..." }): void {
2150
2495
  const Message = op.Message || "加载中...";
@@ -2159,7 +2504,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2159
2504
  },
2160
2505
 
2161
2506
  /**
2162
- * 隐藏加载dialog
2507
+ * 隐藏加载dialog
2508
+ * params: 无
2509
+ * return: 无
2510
+ * Explanation: 关闭由ShowLoading方法打开的加载框
2511
+ * USE: HideLoading()
2163
2512
  * */
2164
2513
  HideLoading: function (): void {
2165
2514
  callMethod({
@@ -2173,7 +2522,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2173
2522
  },
2174
2523
 
2175
2524
  /**
2176
- * 显示msg弹窗
2525
+ * 显示msg弹窗
2526
+ * params: {
2527
+ * Title: 弹出框标题 string 必填
2528
+ * Message: 弹出框详情 string 必填
2529
+ * confirmButtonText: 弹出框确认文字 string 必填
2530
+ * }
2531
+ * return: Promise<string>
2532
+ * Explanation: resolve: 确认按钮点击时返回comfirm
2533
+ * USE: ShowMsg({Title: "", Message: "", confirmButtonText: ""}).then(res=>{})
2177
2534
  * */
2178
2535
  ShowMsg: function (op: ShowMsgType = { Title: "", Message: "", confirmButtonText: "" }): Promise<string> {
2179
2536
  return new Promise((resolve, reject) => {
@@ -2202,7 +2559,16 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2202
2559
  },
2203
2560
 
2204
2561
  /**
2205
- * 确认弹出框
2562
+ * 确认弹出框
2563
+ * params: {
2564
+ * Title: 弹出框标题 string 必填
2565
+ * Message: 弹出框详情 string 必填
2566
+ * ConfirmText: 弹出框确认文字 object 必填
2567
+ * CancelText: 弹出框关闭文字 string 必填
2568
+ * }
2569
+ * return: Promise<string>
2570
+ * Explanation: resolve: 确认按钮点击时返回comfirm reject: 关闭按钮点击时返回cancel
2571
+ * USE: ShowDialog({Title: "", Message: "", ConfirmText: "", CancelText: ""}).then(res=>{}).catch(err=>{})
2206
2572
  * */
2207
2573
  ShowDialog: function (op: ShowDialogType = { Title: "", Message: "", ConfirmText: "", CancelText: "" }): Promise<string> {
2208
2574
  return new Promise((resolve, reject) => {
@@ -2248,7 +2614,17 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2248
2614
  },
2249
2615
 
2250
2616
  /**
2251
- * 添加页面浮窗(返回时添加页面标签至浮窗)
2617
+ * 添加页面浮窗
2618
+ * params: {
2619
+ * Url: 打开页面链接 string 必填
2620
+ * Title: 浮窗标题 string 必填
2621
+ * Detail: 浮窗详情 string 必填
2622
+ * Params: 浮窗打开参数 object 必填
2623
+ * Icon: 浮窗图标 string 必填
2624
+ * }
2625
+ * return: 无
2626
+ * Explanation: 调用方法后在返回页面时会添加调用页面快捷入口浮窗至返回的页面,点击浮窗可携带参数跳转至记录页面
2627
+ * USE: FloatingWindowData({Url: "", Title: "", Detail: "", Params: {}, Icon: ""})
2252
2628
  * */
2253
2629
  FloatingWindowData: function (op: FloatingWindowDataType = { Url: "", Title: "", Detail: "", Params: {}, Icon: "" }): void {
2254
2630
  const Url = op.Url || "";
@@ -2275,24 +2651,44 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2275
2651
 
2276
2652
  /**
2277
2653
  * 开启陀螺仪
2278
- * */
2279
- OpenGyro: function (op: OpenGyroType = { MaxOffsetX: 100, MaxOffsetY: 100 }): Promise<{ x: number, y: number }> {
2654
+ * params: {
2655
+ * MaxOffsetX: 允许的最大偏移角度 number 必填
2656
+ * MaxOffsetY: 允许的最大偏移角度 number 必填
2657
+ * Callback: 偏移回调方法(返回值:{x:currentX, y: currentY}) function 必填
2658
+ * }
2659
+ * return: 无
2660
+ * Explanation: 调用打开系统陀螺仪,通过回调方法返回当前陀螺仪偏移度
2661
+ * USE: OpenGyro({MaxOffsetX: 100, MaxOffsetY: 100, Callback: (object) => { }})
2662
+ * */
2663
+ OpenGyro: function (op: OpenGyroType = { MaxOffsetX: 100, MaxOffsetY: 100, Callback: () => { } }): void {
2280
2664
  const MaxOffsetX = op.MaxOffsetX || 100;
2281
2665
  const MaxOffsetY = op.MaxOffsetY || 100;
2282
- return asyncReturnMethod({
2666
+ const Callback = op.Callback || (() => { })
2667
+ const MethodName = "OpenGyro";
2668
+ callMethod({
2283
2669
  environment: this.environment,
2284
2670
  methodName: "OpenGyro",
2285
2671
  webMethod: () => {
2286
- return new Promise((resolve, reject) => {
2287
- resolve({ x: MaxOffsetX, y: MaxOffsetY });
2288
- });
2672
+ window.OpenGyro({ x: MaxOffsetX, y: MaxOffsetY })
2289
2673
  },
2290
- params: { MaxOffsetX, MaxOffsetY }
2674
+ params: { MaxOffsetX, MaxOffsetY, MethodName }
2291
2675
  });
2676
+ window.OpenGyro = (data: any) => {
2677
+
2678
+ try {
2679
+ Callback({ x: data.x, y: data.y })
2680
+ } catch (error) {
2681
+ Callback({ x: MaxOffsetX, y: MaxOffsetY })
2682
+ }
2683
+ }
2292
2684
  },
2293
2685
 
2294
2686
  /**
2295
2687
  * 关闭陀螺仪
2688
+ * params: 无
2689
+ * return: 无
2690
+ * Explanation: 关闭打开的陀螺仪
2691
+ * USE: CloseGyro()
2296
2692
  * */
2297
2693
  CloseGyro: function (): void {
2298
2694
  callMethod({
@@ -2306,7 +2702,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2306
2702
  },
2307
2703
 
2308
2704
  /**
2309
- * 拨打电话
2705
+ * 拨打电话
2706
+ * params: {
2707
+ * Phone: 需要拨打的手机号 string 必填
2708
+ * }
2709
+ * return: 无
2710
+ * Explanation: 调用拨打电话
2711
+ * USE: PhoneCall({Phone: '13000000000'})
2310
2712
  * */
2311
2713
  PhoneCall: function (op: PhoneCallType = { Phone: "" }): void {
2312
2714
  const Phone = op.Phone || "";
@@ -2322,6 +2724,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2322
2724
 
2323
2725
  /**
2324
2726
  * 保存IOS云端密码(IOS独有)
2727
+ * params: {
2728
+ * UserName: 用户名 string 必填
2729
+ * Password: 密码 string 必填
2730
+ * }
2731
+ * return: 无
2732
+ * Explanation: 登录成功时保存IOS云端密码,不调用则不保存账号密码(IOS独有),安卓调用webview自带的账号密码记住功能
2733
+ * USE: SaveToiCloud({UserName: '13000000000', Password: '123456789'})
2325
2734
  * */
2326
2735
  SaveToiCloud: function (op: SaveToiCloudType = { UserName: "", Password: "" }): void {
2327
2736
  const UserName = op.UserName || "";
@@ -2342,7 +2751,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2342
2751
  },
2343
2752
 
2344
2753
  /**
2345
- * 关闭IOS底部安全区域(IOS独有)
2754
+ * 关闭IOS底部安全区域
2755
+ * params: 无
2756
+ * return: 无
2757
+ * Explanation: IOS默认会有底部安全区域高度,调用此方法关闭IOS底部安全区域(IOS独有)
2758
+ * USE: FullScreen()
2346
2759
  * */
2347
2760
  FullScreen: function (): void {
2348
2761
  callMethod({
@@ -2358,7 +2771,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2358
2771
 
2359
2772
  /**
2360
2773
  * 键盘占位
2361
- * parameter: true/false
2774
+ * params: {
2775
+ * Status: 键盘占位状态 (true: 键盘占位 false: 键盘不占位) boolean 必填
2776
+ * }
2777
+ * return: 无
2778
+ * Explanation: 默认键盘不占位,调用此方法可修改键盘是否占位
2779
+ * USE: Keyboard({Status: true})
2362
2780
  * */
2363
2781
  Keyboard: function (op: KeyboardType = { Status: true }): void {
2364
2782
  const Status = op.Status ? true : false;
@@ -2388,8 +2806,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2388
2806
  },
2389
2807
 
2390
2808
  /**
2391
- * Android初始化阿里云推送(Android独有)
2392
- * 调用重新初始化阿里云推送,针对手动屏蔽通知后重新开启
2809
+ * Android初始化阿里云推送
2810
+ * params: {
2811
+ * Account: 阿里云推送登录账号(程序唯一值)string 必填
2812
+ * }
2813
+ * return: 无
2814
+ * Explanation: 调用重新初始化阿里云推送,针对手动屏蔽通知后重新开启(Android独有)
2815
+ * USE: InitCloudChannel({Account: "13000000000"})
2393
2816
  * */
2394
2817
  InitCloudChannel: function (op: BindCloudChannelType = { Account: "" }): void {
2395
2818
  const Account = op.Account || "";
@@ -2409,7 +2832,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2409
2832
  },
2410
2833
 
2411
2834
  /**
2412
- * 微信登录
2835
+ * 微信登录
2836
+ * params: 无
2837
+ * return: 无
2838
+ * Explanation: 功能暂未实现
2839
+ * USE: WeChatLogin()
2413
2840
  * */
2414
2841
  WeChatLogin: function (): void {
2415
2842
  callMethod({
@@ -2423,7 +2850,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2423
2850
  },
2424
2851
 
2425
2852
  /**
2426
- * QQ登录
2853
+ * QQ登录
2854
+ * params: 无
2855
+ * return: 无
2856
+ * Explanation: 功能暂未实现
2857
+ * USE: QQLogin()
2427
2858
  * */
2428
2859
  QQLogin: function (): void {
2429
2860
  callMethod({
@@ -2438,6 +2869,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2438
2869
 
2439
2870
  /**
2440
2871
  * 启动本地服务器(仅APP环境)
2872
+ * params: 无
2873
+ * return: 无
2874
+ * Explanation: 启动本地服务器(仅APP环境)
2875
+ * USE: StartHttpServer()
2441
2876
  * */
2442
2877
  StartHttpServer: function (): void {
2443
2878
  callMethod({
@@ -2451,7 +2886,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2451
2886
  },
2452
2887
 
2453
2888
  /**
2454
- * 关闭本地服务器(仅APP环境)
2889
+ * 关闭本地服务器
2890
+ * params: 无
2891
+ * return: 无
2892
+ * Explanation: 关闭本地服务器(仅APP环境)
2893
+ * USE: StopHttpServer()
2455
2894
  * */
2456
2895
  StopHttpServer: function (): void {
2457
2896
  callMethod({
@@ -2465,7 +2904,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2465
2904
  },
2466
2905
 
2467
2906
  /**
2468
- * 支付宝支付
2907
+ * 支付宝支付
2908
+ * params: {
2909
+ * OrderInfo: 订单支付的必要信息 string 必填
2910
+ * SuccessUrl: 支付成功后的返回地址 string 必填
2911
+ * FailUrl: 支付失败后的返回地址 string 必填
2912
+ * }
2913
+ * return: 无
2914
+ * Explanation: 调起微信支付(APP需在OMEGA项目中配置支付宝支付相关参数,web 端暂未实现该功能)
2915
+ * USE: RequestAlipay({OrderInfo: "kdohkoji5i4534645", SuccessUrl: "pay-success", FailUrl: "pay-fail"})
2469
2916
  * */
2470
2917
  RequestAlipay: function (op: RequestPayType = { OrderInfo: "", SuccessUrl: "", FailUrl: "" }): void {
2471
2918
  const OrderInfo = op.OrderInfo || "";
@@ -2487,7 +2934,15 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2487
2934
  },
2488
2935
 
2489
2936
  /**
2490
- * 微信支付
2937
+ * 微信支付
2938
+ * params: {
2939
+ * OrderInfo: 订单支付的必要信息 string 必填
2940
+ * SuccessUrl: 支付成功后的返回地址 string 必填
2941
+ * FailUrl: 支付失败后的返回地址 string 必填 必填
2942
+ * }
2943
+ * return: 无
2944
+ * Explanation: 调起微信支付(APP需在OMEGA项目中配置微信支付相关参数,web 端暂未实现该功能)
2945
+ * USE: RequestWechatPay({OrderInfo: "kdohkoji5i4534645", SuccessUrl: "pay-success", FailUrl: "pay-fail"})
2491
2946
  * */
2492
2947
  RequestWechatPay: function (op: RequestPayType = { OrderInfo: "", SuccessUrl: "", FailUrl: "" }): void {
2493
2948
  const OrderInfo = op.OrderInfo;
@@ -2509,7 +2964,11 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2509
2964
  },
2510
2965
 
2511
2966
  /**
2512
- * 缓存大小
2967
+ * 缓存大小
2968
+ * params: 无
2969
+ * return: string
2970
+ * Explanation: 获取当前应用程序的缓存大小
2971
+ * USE: CacheSize()
2513
2972
  * */
2514
2973
  CacheSize: function (): string {
2515
2974
  return syncReturnMethod({
@@ -2525,20 +2984,32 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2525
2984
 
2526
2985
  /**
2527
2986
  * 客服中心
2987
+ * params: {
2988
+ * Url: web端跳转的客服地址 string 必填
2989
+ * }
2990
+ * return: 无
2991
+ * Explanation: 跳转客服中心(APP需在OMEGA项目中配置客服相关参数)
2992
+ * USE: OnlineService({Url: "http://oss.kexiaoshuang.com/MEIQIA/chatlink.html"})
2528
2993
  * */
2529
- OnlineService: function (): void {
2994
+ OnlineService: function (op: OnlineServiceType = { Url: "" }): void {
2995
+ const Url = op.Url || "http://oss.kexiaoshuang.com/MEIQIA/chatlink.html";
2530
2996
  callMethod({
2531
2997
  environment: this.environment,
2532
2998
  methodName: "OnlineService",
2533
2999
  webMethod: () => {
2534
- window.location.href =
2535
- "http://oss.kexiaoshuang.com/MEIQIA/chatlink.html";
3000
+ window.location.href = Url;
2536
3001
  },
2537
3002
  params: {}
2538
3003
  });
2539
3004
  },
2540
3005
  /**
2541
3006
  * 打开高德地图
3007
+ * params: {
3008
+ * Address: 打开地图后搜索的地址 string 必填
3009
+ * }
3010
+ * return: Promise<string | any>
3011
+ * Explanation: 打开高德地图并搜索地址,打开失败后调用promise的resolve方法
3012
+ * USE: OpenAmap({Address: "天安门"}).then(()=>{ })
2542
3013
  * */
2543
3014
  OpenAmap: function (op: OpenAmapType = { Address: "" }): Promise<any> {
2544
3015
  const Address = op.Address || "";
@@ -2559,8 +3030,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2559
3030
  },
2560
3031
  /**-
2561
3032
  * 选择视频(单个视频,相机/相册)
2562
- * VideoDuration: 录制时长
2563
- * ReturnType: 返回类型 URL/Object[file]
3033
+ * params: {
3034
+ * VideoDuration: 录制时长(s) number 必填
3035
+ * ReturnType: 返回类型 URL/Object[file] string 必填
3036
+ * }
3037
+ * return: Promise<string | file>
3038
+ * Explanation: 根据ReturnType参数返回不同的数据(url/file)
3039
+ * USE: UploadVideo({VideoDuration: 60, ReturnType: "Object[file]"}).then(res=>{ })
2564
3040
  * */
2565
3041
  UploadVideo: function (op: UploadVideoType = { VideoDuration: 60, ReturnType: "Object[file]" }): Promise<any> {
2566
3042
  const VideoDuration = op.VideoDuration || 60;
@@ -2608,7 +3084,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2608
3084
  },
2609
3085
  /**
2610
3086
  * 字符串分词
2611
- * KeyWord: 需要分词的字符串
3087
+ * params: {
3088
+ * KeyWord: 需要分词的字符串 string 必填
3089
+ * }
3090
+ * return: Promise<Array<分割后的词组>>
3091
+ * Explanation: 返回分词后的字符串数组
3092
+ * USE: CutWord({KeyWord:'中华人民共和国'}).then(res=>{ })
2612
3093
  * */
2613
3094
  CutWord: function (op: MapSearchType = { KeyWord: "" }): Promise<Array<string> | any> {
2614
3095
  const KeyWord = op.KeyWord || "";
@@ -2657,7 +3138,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2657
3138
 
2658
3139
  /**
2659
3140
  * 页面埋点记录
2660
- * Type: 类型(1:开启,0:关闭)
3141
+ * params: {
3142
+ * Type: 类型(1: 开启埋点,0: 关闭埋点) boolean 必填
3143
+ * }
3144
+ * return: Type为1无返回值,为0返回Promise<Array<object>> {url: 页面记录, stayTime: 页面停留时间}
3145
+ * Explanation: 获取当前页面埋点记录
3146
+ * USE: 1、StayTime({Type:1}) 2、StayTime({Type:0}).then(res=>{ })
2661
3147
  * */
2662
3148
  StayTime: function (op: OCRIdCardParamsType = { Type: 0 }): Promise<string> | void {
2663
3149
  const type = op.Type == 0 ? 0 : 1;
@@ -2690,7 +3176,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2690
3176
 
2691
3177
  /**
2692
3178
  * 播放视频
2693
- * VideoUrl: 视频链接
3179
+ * params: {
3180
+ * VideoUrl: 视频链接 string 必填
3181
+ * }
3182
+ * return: 无
3183
+ * Explanation: 打开传入的视频链接进行播放(播放功能有:暂停播放、进度条、关闭)
3184
+ * USE: PlayVideo({VideoUrl:'https://video.mp4'})
2694
3185
  * */
2695
3186
  PlayVideo: function (op: PlayVideoType = { VideoUrl: "" }): void {
2696
3187
  const VideoUrl = op.VideoUrl || ""
@@ -2705,8 +3196,13 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2705
3196
  },
2706
3197
  /**
2707
3198
  * 下载视频
2708
- * VideoUrl: 视频链接
2709
- * Callback: 进度回调方法
3199
+ * params: {
3200
+ * VideoUrl: 视频链接 string 必填
3201
+ * Callback: 进度回调方法(返回值为当前视频下载进度,0-100,若返回值大于等于100则表示文件下载完成) function 非必填
3202
+ * }
3203
+ * return: 无
3204
+ * Explanation: 超过录制时长自动结束并返回录制的音频文件路径
3205
+ * USE: VideoDownload({VideoUrl:'https://video.mp4',Callback:(progress)=>{ }})
2710
3206
  * */
2711
3207
  VideoDownload: function (op: VideoDownloadType = { VideoUrl: "", Callback: () => { } }): void {
2712
3208
  const VideoUrl = op.VideoUrl || ""
@@ -2733,7 +3229,12 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2733
3229
  },
2734
3230
  /**
2735
3231
  * 音频开始录制
2736
- * Duration: 录制市场(s)
3232
+ * params: {
3233
+ * Duration: 录制市场(s) number 必填
3234
+ * }
3235
+ * return: Promise<string: 音频文件路径>
3236
+ * Explanation: 超过录制时长自动结束并返回录制的音频文件路径
3237
+ * USE: StartAudioRecording({Duration:5}).then(res=>{ })
2737
3238
  * */
2738
3239
  StartAudioRecording: function (op: StartAudioRecordingType = { Duration: "" }): Promise<string> {
2739
3240
  const Duration = op.Duration || ""
@@ -2752,6 +3253,10 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
2752
3253
  },
2753
3254
  /**
2754
3255
  * 音频结束录制
3256
+ * params: 无
3257
+ * return: Promise<string: 音频文件路径>
3258
+ * Explanation: 返回录制完成的音频文件路径
3259
+ * USE: StopAudioRecording().then(res=>{ })
2755
3260
  * */
2756
3261
  StopAudioRecording: function (): Promise<string> {
2757
3262
  return asyncReturnMethod({