@tencentcloud/sdk-mcp 1.6.3 → 1.6.5

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 (302) hide show
  1. package/index.js +0 -4
  2. package/knowledge/build-index.js +1 -1
  3. package/knowledge/chunker.js +81 -52
  4. package/knowledge/path-meta.js +181 -21
  5. package/knowledge/search/exact-lookup.js +166 -0
  6. package/knowledge/search/filter-pool.js +73 -19
  7. package/knowledge/search/product-scope-intent.js +2 -2
  8. package/knowledge/search/requires-framework.js +1 -1
  9. package/knowledge/search/search-knowledge.js +234 -57
  10. package/package.json +1 -1
  11. package/resource/_schema/feature-aliases.yaml +1 -0
  12. package/resource/integration/callkit/preset/android/integration.md +3 -5
  13. package/resource/integration/callkit/preset/flutter/integration.md +2 -3
  14. package/resource/integration/callkit/preset/ios/integration.md +2 -5
  15. package/resource/integration/callkit/preset/react/integration.md +12 -26
  16. package/resource/integration/callkit/preset/vue/integration.md +17 -33
  17. package/resource/integration/chat/preset/android/integration.md +44 -14
  18. package/resource/integration/chat/preset/flutter/integration.md +54 -13
  19. package/resource/integration/chat/preset/ios/integration.md +42 -6
  20. package/resource/integration/chat/preset/react/integration.md +30 -28
  21. package/resource/integration/chat/preset/uni-app/integration.md +101 -40
  22. package/resource/integration/chat/preset/vue/integration.md +62 -28
  23. package/resource/integration/livekit/preset/live/android/live-audience-integration.md +133 -0
  24. package/resource/integration/livekit/preset/live/android/live-host-integration.md +225 -0
  25. package/resource/integration/livekit/preset/live/android/live-list-integration.md +278 -0
  26. package/resource/integration/livekit/preset/live/android/prepare-integration.md +271 -0
  27. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +207 -0
  28. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +358 -0
  29. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +246 -0
  30. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +218 -0
  31. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +4 -7
  32. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +5 -12
  33. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +4 -11
  34. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +250 -482
  35. package/resource/integration/roomkit/preset/vue/integration.md +399 -106
  36. package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
  37. package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +20 -0
  38. package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
  39. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +11 -15
  40. package/resource/knowledge/callkit/core-sdk/android/make-call.md +10 -13
  41. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +2 -4
  42. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +10 -17
  43. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +11 -17
  44. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +11 -20
  45. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +10 -15
  46. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +9 -14
  47. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +12 -18
  48. package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +390 -0
  49. package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +317 -0
  50. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +16 -22
  51. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +17 -23
  52. package/resource/knowledge/callkit/core-sdk/web/call-engine.md +39 -0
  53. package/resource/knowledge/callkit/core-sdk/web/call-event.md +341 -0
  54. package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +39 -0
  55. package/resource/knowledge/callkit/faq/android.md +1 -5
  56. package/resource/knowledge/callkit/faq/common.md +10 -12
  57. package/resource/knowledge/callkit/faq/ios.md +5 -7
  58. package/resource/knowledge/callkit/faq/uniapp-app.md +7 -7
  59. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +9 -12
  60. package/resource/knowledge/callkit/faq/web.md +2 -12
  61. package/resource/knowledge/callkit/preset/android/api.md +5 -8
  62. package/resource/knowledge/callkit/preset/ios/api.md +4 -6
  63. package/resource/knowledge/callkit/preset/miniprogram/api.md +295 -0
  64. package/resource/knowledge/callkit/preset/react/api.md +622 -0
  65. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +475 -0
  66. package/resource/knowledge/callkit/preset/vue/api.md +622 -0
  67. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +587 -0
  68. package/resource/knowledge/callkit/preset/web/api.md +1 -1
  69. package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
  70. package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
  71. package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -1
  72. package/resource/knowledge/chat/preset/android/features/language.md +2 -4
  73. package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
  74. package/resource/knowledge/chat/preset/android/features/message-list.md +1 -2
  75. package/resource/knowledge/chat/preset/android/features/search.md +0 -1
  76. package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
  77. package/resource/knowledge/chat/preset/android-view/integration.md +35 -10
  78. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
  79. package/resource/knowledge/chat/preset/flutter/features/language.md +1 -1
  80. package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -1
  81. package/resource/knowledge/chat/preset/flutter/features/search.md +4 -5
  82. package/resource/knowledge/chat/preset/flutter/features/theme.md +1 -1
  83. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
  84. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -1
  85. package/resource/knowledge/chat/preset/ios/features/language.md +2 -5
  86. package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -1
  87. package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
  88. package/resource/knowledge/chat/preset/ios/features/theme.md +1 -1
  89. package/resource/knowledge/chat/preset/ios-uikit/integration.md +57 -166
  90. package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -1
  91. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +3 -3
  92. package/resource/knowledge/chat/preset/react/features/conversation-list.md +3 -3
  93. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +1 -1
  94. package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
  95. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  96. package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -1
  97. package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -4
  98. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +4 -4
  99. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +1 -1
  100. package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -2
  101. package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -2
  102. package/resource/knowledge/chat/preset/vue/features/search.md +0 -1
  103. package/resource/knowledge/chat/preset/vue/features/theme.md +4 -4
  104. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  105. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +2 -5
  106. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +12 -15
  107. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  108. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  109. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  110. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  111. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +2 -4
  112. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  113. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  114. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +2 -4
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
  117. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  118. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +3 -6
  119. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  120. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +12 -15
  121. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  122. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  123. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  124. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +2 -4
  125. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  126. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  127. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +2 -4
  129. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  130. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  131. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +2 -5
  132. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  133. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +3 -6
  134. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  135. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  136. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  137. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +2 -4
  138. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  139. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  140. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +2 -4
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
  143. package/resource/knowledge/livekit/core-sdk/api-reference/vue/capability-matrix.md +82 -0
  144. package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +2 -4
  145. package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +1 -1
  146. package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +1 -1
  147. package/resource/knowledge/livekit/core-sdk/{voice/android/voice-gift.md → features/android/gift.md} +2 -3
  148. package/resource/knowledge/livekit/core-sdk/{live/android/live-live-list.md → features/android/live-list.md} +1 -1
  149. package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
  150. package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +3 -3
  151. package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-gift.md → features/flutter/gift.md} +2 -2
  152. package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
  153. package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -1
  154. package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
  155. package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-barrage.md → features/ios/barrage.md} +2 -2
  156. package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +1 -1
  157. package/resource/knowledge/livekit/core-sdk/{live/ios/live-gift.md → features/ios/gift.md} +8 -9
  158. package/resource/knowledge/livekit/core-sdk/{live/ios/live-live-list.md → features/ios/live-list.md} +2 -2
  159. package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audio-effect.md → features/uni-app/audio-effect.md} +2 -3
  160. package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-barrage.md → features/uni-app/barrage.md} +2 -2
  161. package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +145 -0
  162. package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-gift.md → features/uni-app/gift.md} +6 -7
  163. package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-room-list.md → features/uni-app/live-list.md} +1 -1
  164. package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
  165. package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +2 -4
  166. package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +6 -9
  167. package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +1 -3
  168. package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -6
  169. package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
  170. package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +3 -5
  171. package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +7 -10
  172. package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +561 -0
  173. package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +323 -0
  174. package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +312 -0
  175. package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
  176. package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +2 -4
  177. package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +11 -14
  178. package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -1
  179. package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +1 -4
  180. package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
  181. package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +2 -4
  182. package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +7 -10
  183. package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-co-guest-interaction.md → co-guest-interaction.md} +6 -6
  184. package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-integration.md → integration.md} +6 -7
  185. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
  186. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
  187. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +1 -1
  188. package/resource/knowledge/push/api-reference/android.md +337 -0
  189. package/resource/knowledge/push/api-reference/donut.md +190 -0
  190. package/resource/knowledge/push/api-reference/flutter.md +176 -0
  191. package/resource/knowledge/push/api-reference/harmonyos.md +140 -0
  192. package/resource/knowledge/push/api-reference/ios.md +537 -0
  193. package/resource/knowledge/push/api-reference/react-native.md +154 -0
  194. package/resource/knowledge/push/api-reference/uni-app.md +148 -0
  195. package/resource/knowledge/push/api-reference/unity.md +119 -0
  196. package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
  197. package/resource/knowledge/push/config/android/fcm.md +1 -8
  198. package/resource/knowledge/push/config/android/honor.md +3 -7
  199. package/resource/knowledge/push/config/android/huawei.md +0 -5
  200. package/resource/knowledge/push/config/android/meizu.md +0 -5
  201. package/resource/knowledge/push/config/android/oppo.md +0 -4
  202. package/resource/knowledge/push/config/android/vivo.md +0 -4
  203. package/resource/knowledge/push/config/android/xiaomi.md +0 -2
  204. package/resource/knowledge/push/config/donut.md +33 -46
  205. package/resource/knowledge/push/config/harmonyos.md +6 -9
  206. package/resource/knowledge/push/config/ios.md +2 -9
  207. package/resource/knowledge/push/config/react-native.md +17 -25
  208. package/resource/knowledge/push/config/unity.md +16 -24
  209. package/resource/knowledge/push/config/unreal-engine.md +16 -24
  210. package/resource/knowledge/push/integration/android.md +21 -21
  211. package/resource/knowledge/push/integration/donut.md +24 -34
  212. package/resource/knowledge/push/integration/flutter.md +12 -1
  213. package/resource/knowledge/push/integration/harmonyos.md +2 -1
  214. package/resource/knowledge/push/integration/ios.md +16 -10
  215. package/resource/knowledge/push/integration/react-native.md +10 -14
  216. package/resource/knowledge/push/integration/uni-app.md +10 -6
  217. package/resource/knowledge/push/integration/unity.md +19 -22
  218. package/resource/knowledge/push/integration/unreal-engine.md +7 -9
  219. package/resource/knowledge/push/overview/prepare.md +2 -2
  220. package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
  221. package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +82 -0
  222. package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
  223. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
  224. package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +82 -0
  225. package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
  226. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +1 -1
  227. package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +82 -0
  228. package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
  229. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -4
  230. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +2 -5
  231. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -3
  232. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -2
  233. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +2 -6
  234. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -1
  235. package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +1 -1
  236. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +2 -4
  237. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +2 -3
  238. package/resource/knowledge/roomkit/preset/android/integration.md +14 -16
  239. package/resource/knowledge/roomkit/preset/flutter/integration.md +9 -17
  240. package/resource/knowledge/roomkit/preset/ios/integration.md +9 -17
  241. package/resource/knowledge/roomkit/preset/react/integration.md +0 -4
  242. package/resource/knowledge/trtc/android/TRTCCloud.md +97 -180
  243. package/resource/knowledge/trtc/android/TRTCCloudDef.md +20 -20
  244. package/resource/knowledge/trtc/android/TRTCCloudListener.md +43 -77
  245. package/resource/knowledge/trtc/android/TRTCStatistics.md +1 -1
  246. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +4 -24
  247. package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
  248. package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
  249. package/resource/knowledge/trtc/c++/ITRTCCloud.md +96 -189
  250. package/resource/knowledge/trtc/c++/ITRTCStatistics.md +1 -1
  251. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +1 -21
  252. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -6
  253. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +42 -76
  254. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +18 -19
  255. package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
  256. package/resource/knowledge/trtc/ios/TRTCCloud.md +95 -181
  257. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +43 -78
  258. package/resource/knowledge/trtc/ios/TRTCStatistics.md +1 -1
  259. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +1 -20
  260. package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -6
  261. package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
  262. package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +20 -20
  263. package/server-config.js +7 -4
  264. package/server.js +2 -2
  265. package/tools/common/finalize_answer.js +1 -1
  266. package/tools/common/present_framework_choice.js +2 -2
  267. package/tools/common/search_trtc_knowledge.js +3 -3
  268. package/tools/common/submit_feedback.js +1 -1
  269. package/tools/definitions/get_native_live_uikit_integration_def.js +60 -0
  270. package/tools/definitions/get_native_livekit_core_integration_def.js +1 -1
  271. package/tools/definitions/present_framework_choice_def.js +2 -2
  272. package/tools/definitions/search_trtc_knowledge_def.js +5 -5
  273. package/tools/index.js +2 -0
  274. package/tools/live/get_native_live_uikit_integration.js +69 -0
  275. package/tools/live/get_native_livekit_core_integration.js +6 -6
  276. package/utils/is-valid-sdkappid.js +4 -0
  277. package/utils/report-cls-client.js +1 -1
  278. package/utils/report-es-client.js +1 -1
  279. package/resource/index/component-slugs.json +0 -1
  280. package/resource/index/doc-source-urls.json +0 -1
  281. package/resource/index/manifest.json +0 -1
  282. package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -229
  283. package/resource/knowledge/livekit/core-sdk/live/android/live-gift.md +0 -459
  284. package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -506
  285. package/resource/knowledge/livekit/core-sdk/live/flutter/live-gift.md +0 -427
  286. package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
  287. package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -265
  288. package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -214
  289. package/resource/knowledge/livekit/core-sdk/live/ios/live-barrage.md +0 -427
  290. package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -272
  291. package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -486
  292. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +0 -523
  293. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -262
  294. package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -600
  295. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-gift.md +0 -411
  296. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +0 -404
  297. /package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +0 -0
  298. /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
  299. /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
  300. /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
  301. /package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audience-list.md → features/uni-app/audience-list.md} +0 -0
  302. /package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -0
@@ -0,0 +1,337 @@
1
+ 本文介绍 TIMPush Android SDK 的客户端 API,包括 `TIMPushManager`、`TIMPushListener`、`TIMPushCallback`、`TIMPushMessage` 和错误码。
2
+
3
+ ## API 概览
4
+
5
+ ### TIMPushManager
6
+
7
+ `TIMPushManager` 是 TIMPush Android SDK 的推送服务管理类,用于注册推送服务、管理 `RegistrationID`、配置推送通道和前台通知展示,以及添加 Push 监听器。
8
+
9
+ |API|说明|
10
+ |---------|---------|
11
+ |getInstance|获取 TIMPushManager 管理器实例。|
12
+ |registerPush|注册推送服务。|
13
+ |unRegisterPush|反注册关闭离线推送服务。|
14
+ |getRegistrationID|获取推送唯一 ID 标识。|
15
+ |setRegistrationID|自定义设置推送唯一 ID 标识。|
16
+ |addPushListener|添加 Push 监听器。|
17
+ |removePushListener|移除 Push 监听器。|
18
+ |forceUseFCMPushChannel|指定设备离线推送使用 FCM 通道。|
19
+ |disablePostNotificationInForeground|关闭 App 在前台时弹出通知栏。|
20
+
21
+ ### TIMPushListener
22
+
23
+ `TIMPushListener` 是 Push 监听器抽象类。按需重写以下方法,即可接收 Push 消息、推送撤回和通知点击事件。
24
+
25
+ |API|说明|
26
+ |---------|---------|
27
+ |onRecvPushMessage|收到 Push 消息。|
28
+ |onRevokePushMessage|收到 Push 消息撤回通知。|
29
+ |onNotificationClicked|点击通知栏消息回调。|
30
+
31
+ ## 回调类型
32
+
33
+ ### TIMPushCallback
34
+
35
+ TIMPush 通用结果回调抽象类。接口调用成功时触发 `onSuccess`,失败时触发 `onError`。
36
+
37
+ #### 声明
38
+ ``` java
39
+ public abstract class TIMPushCallback<T> {
40
+ public void onSuccess(T data) {}
41
+
42
+ public void onError(int errCode, String errMsg, T data) {}
43
+ }
44
+ ```
45
+
46
+ #### 参数
47
+
48
+ |参数|类型|说明|
49
+ |---------|---------|---------|
50
+ |`data`|`T`|成功或失败回调时返回的数据。|
51
+ |`errCode`|`int`|失败回调时的错误码。|
52
+ |`errMsg`|`String`|失败回调时的错误描述。|
53
+
54
+ ## TIMPushManager
55
+
56
+ ### getInstance
57
+
58
+ 获取 `TIMPushManager` 管理器实例。
59
+
60
+ #### 声明
61
+ ``` java
62
+ public static TIMPushManager getInstance();
63
+ ```
64
+
65
+ #### 返回值
66
+
67
+ `TIMPushManager` 单例对象。后续 API 均通过该实例调用。
68
+
69
+ ### registerPush
70
+
71
+ 注册推送服务。
72
+
73
+ #### 声明
74
+ ``` java
75
+ public abstract void registerPush(Context context, int sdkAppId, String appKey, TIMPushCallback callback);
76
+ ```
77
+
78
+ #### 参数
79
+
80
+ |参数|类型|说明|
81
+ |---------|---------|---------|
82
+ |`context`|`Context`|Android 上下文对象。|
83
+ |`sdkAppId`|`int`|应用的 sdkAppId。|
84
+ |`appKey`|`String`|控制台分配的 appKey。|
85
+ |`callback`|`TIMPushCallback`|注册结果回调。|
86
+
87
+ #### 说明
88
+
89
+ 如果您单独使用推送服务,请正确传递 `sdkAppId` 和 `appKey` 两个参数,即可注册推送服务。
90
+
91
+ 如果您已经集成 IM 产品,请在 IM 登录成功后调用该接口,将 `appKey` 参数设置为 `null`,接入离线推送能力。
92
+
93
+ ### unRegisterPush
94
+
95
+ 反注册关闭离线推送服务。
96
+
97
+ #### 声明
98
+ ``` java
99
+ public abstract void unRegisterPush(TIMPushCallback callback);
100
+ ```
101
+
102
+ #### 参数
103
+
104
+ |参数|类型|说明|
105
+ |---------|---------|---------|
106
+ |`callback`|`TIMPushCallback`|反注册结果回调。|
107
+
108
+ ### getRegistrationID
109
+
110
+ 获取推送唯一 ID 标识。
111
+
112
+ #### 声明
113
+ ``` java
114
+ public abstract void getRegistrationID(TIMPushCallback callback);
115
+ ```
116
+
117
+ #### 参数
118
+
119
+ |参数|类型|说明|
120
+ |---------|---------|---------|
121
+ |`callback`|`TIMPushCallback`|获取结果回调。|
122
+
123
+ #### 说明
124
+
125
+ 注册离线推送服务成功后,通过该接口可获取推送唯一 ID 标识,即 `RegistrationID`,然后可以根据 `RegistrationID` 向指定设备推送消息。
126
+
127
+ `RegistrationID` 是设备的推送唯一标识 ID。默认注册推送服务成功后会自动生成,也支持用户自定义设置,提供用户根据 `RegistrationID` 向指定设备推送消息的能力,卸载重装会改变。
128
+
129
+ ### setRegistrationID
130
+
131
+ 自定义设置推送唯一 ID 标识。
132
+
133
+ #### 声明
134
+ ``` java
135
+ public abstract void setRegistrationID(String registrationID, TIMPushCallback callback);
136
+ ```
137
+
138
+ #### 参数
139
+
140
+ |参数|类型|说明|
141
+ |---------|---------|---------|
142
+ |`registrationID`|`String`|自定义推送唯一标识 ID。|
143
+ |`callback`|`TIMPushCallback`|设置结果回调。|
144
+
145
+ #### 说明
146
+
147
+ 自定义设置设备使用的推送唯一标识 ID,即 `RegistrationID`,需要在注册推送服务之前调用。
148
+
149
+ `RegistrationID` 是设备的推送唯一标识 ID。默认注册推送服务成功后会自动生成,也支持用户自定义设置,提供用户根据 `RegistrationID` 向指定设备推送消息的能力,卸载重装会改变。
150
+
151
+ ### addPushListener
152
+
153
+ 添加 Push 监听器。
154
+
155
+ #### 声明
156
+ ``` java
157
+ public abstract void addPushListener(TIMPushListener listener);
158
+ ```
159
+
160
+ #### 参数
161
+
162
+ |参数|类型|说明|
163
+ |---------|---------|---------|
164
+ |`listener`|`TIMPushListener`|Push 监听器对象。|
165
+
166
+ ### removePushListener
167
+
168
+ 移除 Push 监听器。
169
+
170
+ #### 声明
171
+ ``` java
172
+ public abstract void removePushListener(TIMPushListener listener);
173
+ ```
174
+
175
+ #### 参数
176
+
177
+ |参数|类型|说明|
178
+ |---------|---------|---------|
179
+ |`listener`|`TIMPushListener`|需要移除的 Push 监听器对象。|
180
+
181
+ ### forceUseFCMPushChannel
182
+
183
+ 指定设备离线推送使用 FCM 通道。
184
+
185
+ #### 声明
186
+ ``` java
187
+ public abstract void forceUseFCMPushChannel(boolean enable);
188
+ ```
189
+
190
+ #### 参数
191
+
192
+ |参数|类型|说明|
193
+ |---------|---------|---------|
194
+ |`enable`|`boolean`|`true` 表示使用 FCM 通道;`false` 表示使用本机通道。|
195
+
196
+ #### 说明
197
+
198
+ 需要在注册推送服务之前调用。常用于海外推送走 FCM 通道,例如海外小米手机走 FCM 通道。
199
+
200
+ ### disablePostNotificationInForeground
201
+
202
+ 关闭 App 在前台时弹出通知栏。
203
+
204
+ #### 声明
205
+ ``` java
206
+ public abstract void disablePostNotificationInForeground(boolean disable);
207
+ ```
208
+
209
+ #### 参数
210
+
211
+ |参数|类型|说明|
212
+ |---------|---------|---------|
213
+ |`disable`|`boolean`|`true` 表示关闭;`false` 表示开启。|
214
+
215
+ #### 说明
216
+
217
+ 推送 SDK 收到在线推送时,会自动向通知栏增加 Notification 提示。如果您想自己处理在线推送消息,可以调用该接口关闭自动弹通知栏提示的特性。
218
+
219
+ ## TIMPushListener
220
+
221
+ `TIMPushListener` 是 Push 监听器抽象类。基类已提供空实现,按需重写以下方法即可。
222
+
223
+ 三个回调的触发时机如下:
224
+
225
+ |回调|触发时机|
226
+ |---------|---------|
227
+ |`onRecvPushMessage`|App 在线时,收到带 `offlinePushInfo` 的 IM 消息时触发。|
228
+ |`onRevokePushMessage`|App 在线时,收到消息撤回通知时触发。|
229
+ |`onNotificationClicked`|用户点击通知栏消息时触发。包含 App 离线时由厂商通道(小米 / 华为 / OPPO / vivo / 荣耀 / 魅族 / FCM)下发、点击后拉起 App 的场景。|
230
+
231
+ ### onRecvPushMessage
232
+
233
+ App 在线时,收到带 `offlinePushInfo` 的 IM 消息时触发。App 进程已退出时本回调不会触发。
234
+
235
+ #### 声明
236
+ ``` java
237
+ public void onRecvPushMessage(TIMPushMessage message);
238
+ ```
239
+
240
+ #### 参数
241
+
242
+ |参数|类型|说明|
243
+ |---------|---------|---------|
244
+ |`message`|`TIMPushMessage`|Push 消息对象。|
245
+
246
+ ### onRevokePushMessage
247
+
248
+ App 在线时,收到消息撤回通知时触发。App 进程已退出时本回调不会触发。
249
+
250
+ #### 声明
251
+ ``` java
252
+ public void onRevokePushMessage(String messageID);
253
+ ```
254
+
255
+ #### 参数
256
+
257
+ |参数|类型|说明|
258
+ |---------|---------|---------|
259
+ |`messageID`|`String`|消息唯一标识。|
260
+
261
+ ### onNotificationClicked
262
+
263
+ 用户点击通知栏消息时触发。无论 App 当时在前台、后台还是已退出(点击通知拉起 App),都会触发。
264
+
265
+ #### 声明
266
+ ``` java
267
+ public void onNotificationClicked(String ext);
268
+ ```
269
+
270
+ #### 参数
271
+
272
+ |参数|类型|说明|
273
+ |---------|---------|---------|
274
+ |`ext`|`String`|离线消息透传字段。|
275
+
276
+ #### 说明
277
+
278
+ 需要先在腾讯云控制台将推送证书的「点击后续动作」配置为「打开应用内指定界面」,并保持默认填充值,否则本回调不会触发。
279
+
280
+ ## TIMPushMessage
281
+
282
+ `TIMPushMessage` 表示 Push 消息对象,实现 `Serializable` 接口。
283
+
284
+ ### 构造方法
285
+
286
+ #### 声明
287
+ ``` java
288
+ public TIMPushMessage();
289
+ ```
290
+
291
+ ### 属性
292
+
293
+ |属性|类型|说明|
294
+ |---------|---------|---------|
295
+ |`title`|`String`|离线推送标题。|
296
+ |`desc`|`String`|离线推送内容。|
297
+ |`ext`|`String`|离线推送透传内容。|
298
+ |`messageID`|`String`|消息唯一标识 ID。|
299
+
300
+ ### 方法
301
+
302
+ |方法|返回类型|说明|
303
+ |---------|---------|---------|
304
+ |`setTitle(String title)`|`void`|设置离线推送标题。|
305
+ |`getTitle()`|`String`|获取离线推送标题。|
306
+ |`setDesc(String description)`|`void`|设置离线推送内容。|
307
+ |`getDesc()`|`String`|获取离线推送内容。|
308
+ |`setExt(String ext)`|`void`|设置离线推送透传内容。|
309
+ |`getExt()`|`String`|获取离线推送透传内容。|
310
+ |`setMessageID(String messageID)`|`void`|设置消息唯一标识 ID。|
311
+ |`getMessageID()`|`String`|获取消息唯一标识 ID。|
312
+ |`toString()`|`String`|返回消息对象的字符串描述。|
313
+
314
+ ## 错误码
315
+
316
+ `TIMPushConstants` 定义 TIMPush SDK 的业务错误码。
317
+
318
+ |错误码|枚举值|说明|
319
+ |---------|---------|---------|
320
+ |`ERR_INVALID_PARAM`|`800000`|参数不合法。|
321
+ |`ERR_NOT_LOGINED`|`800001`|注册 Push 之前,未登录 IM 账号。|
322
+ |`ERR_INVALID_SDK_APPID`|`800002`|注册 Push 参数 sdkAppID 不合法。|
323
+ |`ERR_REGISTER_PUSH_INIT_FAILED`|`800003`|初始化 SDK 失败。|
324
+ |`ERR_REGISTER_PUSH_CONNECT_FAILED`|`800004`|长链接建立失败。|
325
+ |`ERR_REGISTER_PUSH_FAILED_BUILT_IN_DEVICE`|`800005`|本机通道注册推送失败。|
326
+ |`ERR_REGISTER_PUSH_FAILED_TRY_FCM`|`800006`|本机通道注册推送失败后,尝试 FCM 通道注册失败。|
327
+ |`ERR_REGISTER_PUSH_FAILED_DETECT_CHANNELS`|`800007`|探测所有通道失败。|
328
+ |`ERR_REGISTER_PUSH_FAILED_TIMEOUT`|`800008`|注册推送服务超时。|
329
+ |`ERR_REGISTER_TOKEN_EMPTY`|`800009`|注册推送 token 为空。|
330
+ |`ERR_SET_PUSH_TOKEN_FAILED`|`800010`|给 SDK 设置 token 失败。|
331
+ |`ERR_DISABLE_AUTO_REGISTER_PUSH_FAILED`|`800011`|关闭自动注册失败。|
332
+ |`ERR_DISABLE_REQUEST_POST_NOTIFICATION_PERMISSION_FAILED`|`800012`|关闭推送权限请求失败。|
333
+ |`ERR_CREATE_NOTIFICATION_CHANNEL_FAILED`|`800013`|创建通知 channel 失败。|
334
+ |`ERR_SET_PUSH_CONFIG_FAILED`|`800014`|设置推送配置失败。|
335
+ |`ERR_CALL_EXPERIMENTAL_API_FAILED`|`800015`|实验性接口调用失败。|
336
+ |`ERR_SET_APP_LANGUAGE_FAILED`|`800016`|配置设备语言失败。|
337
+ |`ERR_HTTPS_REQUEST_FAILED`|`800017`|HTTPS 请求失败。|
@@ -0,0 +1,190 @@
1
+ ## 接口概览
2
+
3
+ |API|描述|
4
+ |---------|---------|
5
+ |setRegistrationID|设置注册推送服务使用的推送 ID 标识,即 RegistrationID,需要在注册推送服务之前调用。|
6
+ |getRegistrationID|注册推送服务成功后,获取推送 ID 标识,即 RegistrationID。|
7
+ |registerPush|注册推送服务 (必须在 App 用户同意了隐私政策,并且确定为 App 用户开始提供推送服务后,再调用该接口使用推送服务)。|
8
+ |unRegisterPush|反注册关闭推送服务。|
9
+ |addPushListener|订阅推送事件,如点击通知栏事件。|
10
+ |removePushListener|取消订阅推送事件。|
11
+ |disablePostNotificationInForeground|应用在前台时,开/关通知栏通知(默认开)。|
12
+ |createNotificationChannel|创建客户端通知 channel。此接口可实现自定义铃音功能。|
13
+ |setCustomBadgeNumber|设置应用角标数字(仅华为、iOS)|
14
+
15
+ ## 接口详情
16
+
17
+ ### 注册推送服务
18
+
19
+ > **注意:**
20
+ >
21
+ > 必须在 App 用户同意了隐私政策,并且确定为 App 用户开始提供推送服务后,再调用该接口使用推送服务。否则可能因提前获取用户隐私导致上架失败。
22
+ >
23
+
24
+ #### 接口
25
+ ``` typescript
26
+ registerPush(sdkAppID: number, appKey: string): Promise<JSON>;
27
+ ```
28
+
29
+ #### 参数说明
30
+
31
+ |参数|类型|说明|获取路径|
32
+ |---------|---------|---------|---------|
33
+ |sdkAppID|number|推送(Push)应用 ID|[IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier)<br>|
34
+ |appKey|string|推送(Push)应用客户端密钥||
35
+
36
+ #### 返回值说明
37
+
38
+ |返回值|说明|
39
+ |---------|---------|
40
+ |Promise|成功返回 {"errCode":0,"errMsg":"success","data":{"token":"xxx"}},失败返回 { errCode: number, errMsg: string }|
41
+
42
+ ### 反注册关闭推送服务
43
+
44
+ #### 接口
45
+ ``` typescript
46
+ unRegisterPush(): Promise<JSON>;
47
+ ```
48
+
49
+ #### 返回值说明
50
+
51
+ |返回值|说明|
52
+ |---------|---------|
53
+ |Promise|成功返回 {"errCode":0,"errMsg":"success"},失败返回 { errCode: number, errMsg: string }|
54
+
55
+ ### 设置推送 ID 标识 RegistrationID
56
+
57
+ > **注意:**
58
+ >
59
+ > 需要在注册推送服务之前调用。
60
+ >
61
+
62
+ #### 接口
63
+ ``` typescript
64
+ setRegistrationID(registrationID: string): Promise<JSON>;
65
+ ```
66
+
67
+ #### 参数说明
68
+
69
+ |参数|类型|必填|说明|
70
+ |---------|---------|---------|---------|
71
+ |registrationID|string|是|设备的推送标识 ID,卸载重装会改变|
72
+
73
+ #### 返回值说明
74
+
75
+ |返回值|说明|
76
+ |---------|---------|
77
+ |Promise|成功返回 {"errCode":0,"errMsg":"success"},失败返回 { errCode: number, errMsg: string }|
78
+
79
+ ### 获取推送 ID 标识 RegistrationID
80
+
81
+ > **说明:**
82
+ >
83
+ > 需要在注册推送服务成功之后调用。
84
+ >
85
+
86
+ #### 接口
87
+ ``` typescript
88
+ getRegistrationID(): Promise<JSON>;
89
+ ```
90
+
91
+ #### 返回值说明
92
+
93
+ |返回值|说明|
94
+ |---------|---------|
95
+ |Promise|成功返回 {"errCode":0,"errMsg":"success","data":{"registrationID":"xxx"}},失败返回 { errCode: number, errMsg: string }|
96
+
97
+ ### 订阅推送事件,如点击通知栏事件
98
+
99
+ #### 接口
100
+ ``` typescript
101
+ addPushListener(eventName: string, listener: (res: any) => void): void;
102
+ ```
103
+
104
+ #### 参数说明
105
+
106
+ |参数|类型|必填|说明|
107
+ |---------|---------|---------|---------|
108
+ |eventName|string|是|推送事件类型,可查看 Push.EventName|
109
+ |listener|(res: any) => void|是|推送事件处理方法|
110
+
111
+ ### 取消订阅推送事件
112
+
113
+ #### 接口
114
+ ``` typescript
115
+ removePushListener(eventName: string, listener: (res: any) => void): void;
116
+ ```
117
+
118
+ #### 参数说明
119
+
120
+ |参数|类型|必填|说明|
121
+ |---------|---------|---------|---------|
122
+ |eventName|string|是|推送事件类型,可查看 Push.EventName|
123
+ |listener|(res: any) => void|是|推送事件处理方法|
124
+
125
+ ### 应用在前台时,开/关通知栏通知
126
+
127
+ #### 接口
128
+ ``` typescript
129
+ disablePostNotificationInForeground(disable: boolean): void;
130
+ ```
131
+
132
+ #### 参数说明
133
+ | 参数 | 类型 | 必填 | 说明 |
134
+ | --- | --- | --- | --- |
135
+ | disable | boolean | 是 | 应用在前台时,开/关通知栏通知,默认开:<br>- true: 应用在前台时,关闭通知栏通知。<br>- false: 应用在前台时,开启通知栏通知。 |
136
+
137
+ ### 创建客户端通知 channel
138
+
139
+ > **说明:**
140
+ >
141
+ > 如果不同厂商的 ChannelID 各不相同,那么每个 Channel 都需要创建。
142
+ >
143
+
144
+ #### 接口
145
+ ``` typescript
146
+ createNotificationChannel(options: {
147
+ channelID: string;
148
+ channelName: string;
149
+ channelDesc?: string;
150
+ channelSound?: string;
151
+ }): Promise<JSON>;
152
+ ```
153
+
154
+ #### 参数说明
155
+ | 参数 | 类型 | 必填 | 说明 |
156
+ | --- | --- | --- | --- |
157
+ | options.channelID | String | 是 | 自定义 channel 的 ID。 |
158
+ | options.channelName | String | 是 | 自定义 channel 的名称。 |
159
+ | options.channelDesc | String | 否 | 自定义 channel 的描述。 |
160
+ | options.channelSound | String | 否 | 自定义 channel 铃音的音频文件名,不带文件扩展名,音频文件需要放到 xxx/android/nativeResources/res/raw 中。<br>例如:options.channelSound = private_ring,即设置 xxx/android/nativeResources/res/raw/private_ring.mp3 为自定义铃音。 |
161
+
162
+ #### 返回值说明
163
+
164
+ |返回值|说明|
165
+ |---------|---------|
166
+ |Promise|成功返回 {"errCode":0,"errMsg":"success"},失败返回 { errCode: number, errMsg: string }|
167
+
168
+ ### 设置应用角标数字
169
+
170
+ > **注意:**
171
+ >
172
+ > - 需要在注册推送服务之后调用。
173
+ > - 仅支持华为、iOS。
174
+
175
+ #### 接口
176
+ ``` typescript
177
+ setCustomBadgeNumber(badgeNumber: number): Promise<JSON>;
178
+ ```
179
+
180
+ #### 参数说明
181
+
182
+ |参数|类型|必填|说明|
183
+ |---------|---------|---------|---------|
184
+ |badgeNumber|number|是|应用角标数字|
185
+
186
+ #### 返回值说明
187
+
188
+ |返回值|说明|
189
+ |---------|---------|
190
+ |Promise|成功返回 {"errCode":0,"errMsg":"success"},失败返回 { errCode: number, errMsg: string }|
@@ -0,0 +1,176 @@
1
+ ## TencentCloudChatPush
2
+
3
+ class TencentCloudChatPush:推送插件接口类。
4
+
5
+ ## 接口概览
6
+
7
+ ### 注册/反注册推送服务接口
8
+
9
+ |API|描述|
10
+ |---------|---------|
11
+ |registerPush|注册推送服务,可选覆盖推送信息来自接口参数 json。|
12
+ |unRegisterPush|反注册推送服务。|
13
+ |setRegistrationID|RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是,卸载并重新安装设备会更改 RegistrationID,因此需要在注册推送服务之前调用 setRegistrationID 接口。|
14
+ |getRegistrationID|在成功注册推送服务后,可通过调用 getRegistrationID 接口获取推送接收设备的唯一标识 ID,即 RegistrationID。您可根据 RegistrationID 向指定设备推送消息。|
15
+
16
+ ### Push 全局监听接口
17
+
18
+ |API|描述|
19
+ |---------|---------|
20
+ |addPushListener|添加 Push 监听器。|
21
+ |removePushListener|移除 Push 监听器。|
22
+
23
+ ### 自定义配置接口
24
+
25
+ |API|描述|
26
+ |---------|---------|
27
+ |forceUseFCMPushChannel|指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。|
28
+ |disablePostNotificationInForeground|关闭 App 在前台时弹出通知栏。|
29
+
30
+ ## 接口详情
31
+
32
+ ### 推送插件类
33
+
34
+ TencentCloudChatPush():获取 TencentCloudChatPush 推送插件实例,是一个静态单例。后续步骤, 均通过此单例实例, 进行方法调用。
35
+
36
+ ### 成员函数说明
37
+
38
+ #### registerPush
39
+
40
+ 注册推送服务,IM 账号登录成功后调用。
41
+
42
+ **示例代码:**
43
+ ``` java
44
+ void _onNotificationClicked({required String ext, String? userID, String? groupID}) {
45
+ print("_onNotificationClicked: $ext, userID: $userID, groupID: $groupID");
46
+ /// 自定义处理
47
+ }
48
+ TencentCloudChatPush().registerPush(
49
+ onNotificationClicked: _onNotificationClicked,
50
+ sdkAppId: 您的sdkAppId,
51
+ appKey: "客户端密钥",
52
+ apnsCertificateID: 您配置的证书 ID);
53
+ ```
54
+
55
+ **参数说明:**
56
+ | 参数 | 类型 | 说明 | |
57
+ | --- | --- | --- | --- |
58
+ | onNotificationClicked | ext | String | 为该消息所携带的完整 ext 信息,由发送方指定, 如果未指定,则有默认值。您可根据解析该字段,跳转至对应页面。 |
59
+ | userID | String? | 本参数对应 userID,自动尝试解析 ext Json String, 获取里面携带的单聊对方 userID 。<br><strong>说明:</strong><br>如果您未自定义 ext 字段,ext 字段由 SDK 或 UIKit 默认指定,则可使用此处的默认解析。如果尝试解析失败,则为 null 空。 | |
60
+ | groupID | String? | 本参数对应 groupID,自动尝试解析 ext Json String, 获取里面携带的群聊 groupID 信息。<br><strong>说明:</strong><br>如果您未自定义 ext 字段,ext 字段由 SDK 或 UIKit 默认指定,则可使用此处的默认解析。如果尝试解析失败,则为 null 空。 | |
61
+ | sdkAppId | int? | IM 控制台为您分配的应用 ID。 | |
62
+ | appKey | String? | IM 控制台为您分配的客户端密钥。 | |
63
+ | apnsCertificateID | int? | 如单独调用 setApnsCertificateID 方法已配置, 此项可不传。 | |
64
+
65
+ #### unRegisterPush
66
+
67
+ 反注册离线推送服务。
68
+
69
+ **示例代码:**
70
+ ``` java
71
+ TencentCloudChatPush().unRegisterPush();
72
+ ```
73
+
74
+ #### setRegistrationID
75
+
76
+ 设置注册离线推送服务使用的推送 ID 标识, 即 RegistrationID,需要在注册推送服务之前调用。
77
+
78
+ 参数说明:
79
+
80
+ |参数|描述|
81
+ |---------|---------|
82
+ |registrationID|设备的推送标识 ID,卸载重装会改变。|
83
+
84
+ **示例代码:**
85
+ ``` java
86
+ TencentCloudChatPush().setRegistrationID(registrationID: registrationID);
87
+ ```
88
+
89
+ #### getRegistrationID
90
+
91
+ 注册离线推送服务成功后,获取推送 ID 标识,即 RegistrationID。
92
+
93
+ **示例代码:**
94
+ ``` java
95
+ TencentCloudChatPush().getRegistrationID();
96
+ ```
97
+
98
+ #### addPushListener
99
+
100
+ 添加 Push 监听器
101
+
102
+ **示例代码:**
103
+ ``` java
104
+ TIMPushListener timPushListener = TIMPushListener(
105
+ onRecvPushMessage: (TimPushMessage message) {
106
+ String messageLog = message.toLogString();
107
+ debugPrint(
108
+ "message: $messageLog");
109
+ },
110
+
111
+ onRevokePushMessage: (String messageId) {
112
+ debugPrint(
113
+ "message: $messageId");
114
+ },
115
+
116
+ onNotificationClicked: (String ext) {
117
+ debugPrint(
118
+ "ext: $ext");
119
+ }
120
+ );
121
+ TencentCloudChatPush.addPushListener(listener: timPushListener);
122
+ ```
123
+
124
+ #### removePushListener
125
+
126
+ 移除 Push 监听器
127
+
128
+ **示例代码:**
129
+ ``` java
130
+ TIMPushListener timPushListener = TIMPushListener(
131
+ onRecvPushMessage: (TimPushMessage message) {
132
+ String messageLog = message.toLogString();
133
+ debugPrint(
134
+ "message: $messageLog");
135
+ },
136
+
137
+ onRevokePushMessage: (String messageId) {
138
+ debugPrint(
139
+ "message: $messageId");
140
+ },
141
+
142
+ onNotificationClicked: (String ext) {
143
+ debugPrint(
144
+ "ext: $ext");
145
+ }
146
+ );
147
+ TencentCloudChatPush.removePushListener(listener: timPushListener);
148
+ ```
149
+
150
+ #### forceUseFCMPushChannel
151
+
152
+ 指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。
153
+
154
+ 参数说明:
155
+ | 参数 | 描述 |
156
+ | --- | --- |
157
+ | enable | - true:使用 FCM 通道。<br>- false:使用本机通道。 |
158
+
159
+ **示例代码:**
160
+ ``` java
161
+ TencentCloudChatPush.forceUseFCMPushChannel(enable: true);
162
+ ```
163
+
164
+ #### disablePostNotificationInForeground
165
+
166
+ 关闭 App 在前台时弹出通知栏。推送 SDK 收到在线推送时,会自动向通知栏增加 Notification 提示,如果您想自己处理在线推送消息,可以调用该接口关闭自动弹通知栏提示的特性。
167
+
168
+ 参数说明:
169
+ | 参数 | 描述 |
170
+ | --- | --- |
171
+ | disable | - true:关闭。<br>- false:开启。 |
172
+
173
+ **示例代码:**
174
+ ``` java
175
+ TencentCloudChatPush.disablePostNotificationInForeground(disable: true);
176
+ ```