tmui-cli 5.3.1 → 5.3.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.
- package/README.md +120 -2
- package/data/components.json +1 -1
- package/data/config.json +1 -1
- package/data/doc-index.json +1 -1
- package/data/docs/upload-photo.md +1 -0
- package/data/docs/upload-video.md +1 -0
- package/data/examples/navbar.vue +3 -3
- package/data/examples/upload-photo.vue +14 -0
- package/data/examples/upload-video.vue +14 -0
- package/data/guides//346/233/264/346/226/260/346/227/245/345/277/227.md +2 -0
- package/data/tmui4x/01./346/225/231/347/250/213/10./345/205/245/351/227/250/346/214/207/345/215/227/12./345/256/211/350/243/205.md +1 -1
- package/data/tmui4x/01./346/225/231/347/250/213/35.Interface/347/261/273/345/236/213.md +5 -0
- package/data/tmui4x/01./346/225/231/347/250/213/50.TMUI4x/350/222/270/346/261/275/350/256/241/345/210/222.md +18 -2
- package/data/tmui4x/10./346/217/222/344/273/266/345/272/223/xChatmarkdownU AI/350/201/212/345/244/251Markdown.md" +13 -1
- package/data/tmui4x/10./346/217/222/344/273/266/345/272/223/xWebviewU /346/267/267/345/220/210WebView.md" +2 -1
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/205/266/345/256/203/347/273/204/344/273/266//345/216/237/347/224/237/345/233/276/350/241/250 Chart.md" +6 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/205/266/345/256/203/347/273/204/344/273/266//345/233/276/347/211/207/350/243/201/345/211/252 xImageResizer.md" +1 -1
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/205/266/345/256/203/347/273/204/344/273/266//346/200/235/347/273/264/345/257/274/345/233/276 xTreeFlat.md" +1 -1
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/205/266/345/256/203/347/273/204/344/273/266//351/242/234/350/211/262/351/200/211/346/213/251 xColorView.md" +2 -2
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/257/274/350/210/252/347/273/204/344/273/266//345/274/225/345/257/274 xGuid.md" +31 -10
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/257/274/350/210/252/347/273/204/344/273/266//345/274/225/345/257/274/345/255/220/347/273/204/344/273/266 xGuidItem.md" +26 -5
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/257/274/350/210/252/347/273/204/344/273/266//347/264/242/345/274/225 xIndexbar.md" +46 -4
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266/markdown xCmarkdown.md" +9 -2
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266//345/257/214/346/226/207/346/234/254 xHtml.md" +186 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266//345/257/214/346/226/207/346/234/254/345/255/220/347/273/204/344/273/266 xHtmlNode.md" +183 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266//350/241/250/346/240/274 xTable.md" +10 -1
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266//350/241/250/346/240/274/345/210/227 xTableCol.md" +8 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/270/270/347/224/250/347/273/204/344/273/266//345/223/215/345/272/224/345/274/217/345/270/203/345/261/200 xLayout.md" +330 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//345/233/276/347/211/207/344/270/212/344/274/240 xUploadMedia.md" +51 -4
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//345/244/232/351/200/211/346/227/245/345/216/206 xCalendarMultiple.md" +2 -7
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//345/257/214/346/226/207/346/234/254/347/274/226/350/276/221/345/231/250 xEditor.md" +4 -4
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//345/265/214/345/205/245/345/274/217/346/227/245/346/234/237/351/200/211/346/213/251/345/231/250 xDateView.md" +27 -0
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//346/227/245/345/216/206 xCalendar.md" +6 -8
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//346/227/245/346/234/237/351/200/211/346/213/251/345/231/250 xPickerDate.md" +27 -1
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//350/241/250/345/215/225 xForm.md" +36 -28
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//350/241/250/345/215/225/347/273/204/344/273/266//350/241/250/345/215/225/345/255/220/347/273/204/344/273/266 xFormItem.md" +35 -28
- package/data/tmui4x/60.AI/350/207/252/345/212/250/345/214/226/06.tokens/350/207/252/347/224/261.md +47 -0
- package/data/tmui4x-doc-index.json +47 -10
- package/data/uni-app-x-docs/.vuepress/utils/cssJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/customTypeJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/maniFestJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/utsApiJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/utsComJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/utsUnicloudApiJson.json +1 -1
- package/data/uni-app-x-docs/.vuepress/utils/vueJson.json +1 -1
- package/data/uni-app-x-docs/_sidebar.md +2 -1
- package/data/uni-app-x-docs/api/_sidebar.md +3 -0
- package/data/uni-app-x-docs/api/convert2-abs-full-path.md +33 -0
- package/data/uni-app-x-docs/api/create-drama-ad.md +24 -15
- package/data/uni-app-x-docs/api/create-selector-query.md +2 -2
- package/data/uni-app-x-docs/api/create-worker.md +10 -11
- package/data/uni-app-x-docs/api/dialog-page.md +4 -0
- package/data/uni-app-x-docs/api/dom/README.md +1 -1
- package/data/uni-app-x-docs/api/dom/cssstyledeclaration.md +10 -55
- package/data/uni-app-x-docs/api/dom/unielement.md +2 -1
- package/data/uni-app-x-docs/api/dom/uniresizeobserver.md +4 -47
- package/data/uni-app-x-docs/api/event-bus.md +1 -1
- package/data/uni-app-x-docs/api/get-recorder-manager.md +5 -5
- package/data/uni-app-x-docs/api/install-wgt.md +10 -11
- package/data/uni-app-x-docs/api/screen-brightness.md +6 -0
- package/data/uni-app-x-docs/api/theme-change.md +1 -1
- package/data/uni-app-x-docs/api/unicloud/README.md +41 -0
- package/data/uni-app-x-docs/api/unicloud/function.md +1 -1
- package/data/uni-app-x-docs/api/unicloud/object.md +1 -1
- package/data/uni-app-x-docs/api/uniresizeobserver.md +50 -0
- package/data/uni-app-x-docs/app-vapor.md +9 -2
- package/data/uni-app-x-docs/collocation/app.md +2 -2
- package/data/uni-app-x-docs/collocation/manifest-android.md +15 -1
- package/data/uni-app-x-docs/compiler/README.md +1 -1
- package/data/uni-app-x-docs/component/_sidebar.md +4 -1
- package/data/uni-app-x-docs/component/ad-drama.md +8 -13
- package/data/uni-app-x-docs/component/button.md +1 -1
- package/data/uni-app-x-docs/component/icon.md +2 -0
- package/data/uni-app-x-docs/component/image.md +4 -2
- package/data/uni-app-x-docs/component/swiper.md +5 -1
- package/data/uni-app-x-docs/component/text.md +6 -6
- package/data/uni-app-x-docs/component/uni-ui-x/uni-collapse.md +1 -1
- package/data/uni-app-x-docs/component/uni-ui-x/uni-combox.md +4 -0
- package/data/uni-app-x-docs/component/uni-ui-x/uni-icons.md +25 -0
- package/data/uni-app-x-docs/component/uni-ui-x/uni-link.md +1 -1
- package/data/uni-app-x-docs/component/uni-ui-x/uni-nav-bar.md +1 -1
- package/data/uni-app-x-docs/component/uni-ui-x/uni-number-box.md +1 -1
- package/data/uni-app-x-docs/component/uni-ui-x/uni-rate.md +1 -1
- package/data/uni-app-x-docs/component/video.md +2 -2
- package/data/uni-app-x-docs/component/view.md +2 -1
- package/data/uni-app-x-docs/css/common/at-rules.md +8 -2
- package/data/uni-app-x-docs/css/common/selector.md +3 -3
- package/data/uni-app-x-docs/css/common/style-isolation.md +3 -3
- package/data/uni-app-x-docs/css/visibility.md +8 -3
- package/data/uni-app-x-docs/i18n.md +30 -30
- package/data/uni-app-x-docs/mp/README.md +21 -0
- package/data/uni-app-x-docs/mp/native-component-and-wxs.md +1 -1
- package/data/uni-app-x-docs/native/download/android.md +18 -63
- package/data/uni-app-x-docs/native/download/ios.md +5 -5
- package/data/uni-app-x-docs/native/use/android.md +4 -2
- package/data/uni-app-x-docs/native/use/androidcomm.md +154 -40
- package/data/uni-app-x-docs/readme.md +51 -28
- package/data/uni-app-x-docs/sample.md +57 -14
- package/data/uni-app-x-docs/select/crossplatform-on-ai.md +475 -0
- package/data/uni-app-x-docs/select/native-render-and-self-render.md +4 -4
- package/data/uni-app-x-docs/tutorial/compliance.md +6 -6
- package/data/uni-app-x-docs/tutorial/debug/devtools.md +16 -6
- package/data/uni-app-x-docs/tutorial/store.md +1 -1
- package/data/uni-app-x-docs/uniapptox.md +49 -18
- package/data/uni-app-x-docs/uniappvsuniappx.md +160 -38
- package/data/uni-app-x-docs/uts/buildin-object-api/array.md +0 -296
- package/data/uni-app-x-docs/uts/uts2js.md +1 -1
- package/data/uni-app-x-docs/vue/README.md +20 -12
- package/data/uni-app-x-docs/vue/built-in.md +64 -37
- package/data/uni-app-x-docs/vue/component.md +3 -1
- package/data/uni-app-x-docs/vue/composition-api.md +1 -1
- package/data/uni-app-x-docs/web/ssr.md +22 -86
- package/data/uniappx/_sidebar.md +2 -1
- package/data/uniappx/api/_sidebar.md +3 -0
- package/data/uniappx/api/accelerometer.md +96 -96
- package/data/uniappx/api/action-sheet.md +4 -4
- package/data/uniappx/api/app-route.md +20 -0
- package/data/uniappx/api/authentication.md +6 -6
- package/data/uniappx/api/base64.md +4 -4
- package/data/uniappx/api/choose-file.md +2 -2
- package/data/uniappx/api/choose-image.md +2 -2
- package/data/uniappx/api/choose-location.md +2 -2
- package/data/uniappx/api/choose-media.md +2 -2
- package/data/uniappx/api/choose-video.md +2 -2
- package/data/uniappx/api/clipboard.md +4 -4
- package/data/uniappx/api/compass.md +94 -94
- package/data/uniappx/api/connect-event-source.md +2 -2
- package/data/uniappx/api/contact.md +62 -62
- package/data/uniappx/api/convert2-abs-full-path.md +57 -0
- package/data/uniappx/api/create-camera-context.md +2 -2
- package/data/uniappx/api/create-canvas-context-async.md +2 -2
- package/data/uniappx/api/create-drama-ad.md +533 -343
- package/data/uniappx/api/create-editor-context-async.md +2 -2
- package/data/uniappx/api/create-inner-audio-context.md +4 -4
- package/data/uniappx/api/create-request-permission-listener.md +2 -2
- package/data/uniappx/api/create-selector-query.md +2 -2
- package/data/uniappx/api/create-video-context.md +2 -2
- package/data/uniappx/api/create-webview-context.md +4 -4
- package/data/uniappx/api/create-worker.md +11 -11
- package/data/uniappx/api/dialog-page.md +8 -4
- package/data/uniappx/api/dom/cssstyledeclaration.md +1 -46
- package/data/uniappx/api/dom/unielement.md +2 -1
- package/data/uniappx/api/dom/uniresizeobserver.md +2 -19
- package/data/uniappx/api/download-file.md +2 -2
- package/data/uniappx/api/event-bus.md +9 -9
- package/data/uniappx/api/exit.md +2 -2
- package/data/uniappx/api/get-accessibility-info.md +2 -2
- package/data/uniappx/api/get-app-authorize-setting.md +2 -2
- package/data/uniappx/api/get-app-base-info.md +3 -2
- package/data/uniappx/api/get-background-audio-manager.md +2 -2
- package/data/uniappx/api/get-device-info.md +2 -2
- package/data/uniappx/api/get-element-by-id.md +2 -2
- package/data/uniappx/api/get-file-system-manager.md +4 -4
- package/data/uniappx/api/get-location.md +2 -2
- package/data/uniappx/api/get-network-type.md +2 -2
- package/data/uniappx/api/get-recorder-manager.md +28 -28
- package/data/uniappx/api/get-system-info.md +4 -4
- package/data/uniappx/api/get-system-setting.md +2 -2
- package/data/uniappx/api/get-window-info.md +2 -2
- package/data/uniappx/api/gyroscope.md +68 -68
- package/data/uniappx/api/install-apk.md +2 -2
- package/data/uniappx/api/install-wgt.md +26 -53
- package/data/uniappx/api/is-simulator.md +2 -2
- package/data/uniappx/api/keyboard.md +6 -6
- package/data/uniappx/api/launch.md +4 -4
- package/data/uniappx/api/load-font-face.md +2 -2
- package/data/uniappx/api/loading.md +4 -4
- package/data/uniappx/api/make-phone-call.md +2 -2
- package/data/uniappx/api/memory.md +6 -6
- package/data/uniappx/api/modal.md +4 -4
- package/data/uniappx/api/navigator-bar-loading.md +4 -4
- package/data/uniappx/api/network-status-change.md +4 -4
- package/data/uniappx/api/on-tab-bar-mid-button-tap.md +2 -2
- package/data/uniappx/api/open-app-authorize-setting.md +2 -2
- package/data/uniappx/api/open-document.md +2 -2
- package/data/uniappx/api/page-scroll-to.md +2 -2
- package/data/uniappx/api/privacy.md +8 -8
- package/data/uniappx/api/provider.md +4 -4
- package/data/uniappx/api/pull-down-refresh.md +4 -4
- package/data/uniappx/api/report.md +1 -1
- package/data/uniappx/api/request-merchant-transfer.md +2 -2
- package/data/uniappx/api/request-payment.md +2 -2
- package/data/uniappx/api/request-system-permission.md +4 -0
- package/data/uniappx/api/request.md +2 -2
- package/data/uniappx/api/rpx2px.md +2 -2
- package/data/uniappx/api/save-image-to-photos-album.md +2 -2
- package/data/uniappx/api/scan-code.md +2 -2
- package/data/uniappx/api/screen-brightness.md +49 -43
- package/data/uniappx/api/set-navigation-bar-color.md +2 -2
- package/data/uniappx/api/set-navigation-bar-title.md +2 -2
- package/data/uniappx/api/set-tab-bar.md +16 -16
- package/data/uniappx/api/share-with-system.md +2 -2
- package/data/uniappx/api/share.md +2 -2
- package/data/uniappx/api/storage.md +20 -20
- package/data/uniappx/api/theme-change.md +18 -18
- package/data/uniappx/api/toast.md +20 -13
- package/data/uniappx/api/uasm.md +8 -0
- package/data/uniappx/api/unicloud/README.md +151 -3
- package/data/uniappx/api/unicloud/database.md +6 -6
- package/data/uniappx/api/unicloud/function.md +5 -5
- package/data/uniappx/api/unicloud/object.md +5 -5
- package/data/uniappx/api/unicloud/storage.md +9 -9
- package/data/uniappx/api/unicloud/utils.md +18 -18
- package/data/uniappx/api/uniresizeobserver.md +108 -0
- package/data/uniappx/api/upload-file.md +2 -2
- package/data/uniappx/api/vibrate.md +30 -30
- package/data/uniappx/api/virtual-payment.md +2 -2
- package/data/uniappx/api/websocket.md +14 -14
- package/data/uniappx/app-vapor.md +9 -2
- package/data/uniappx/collocation/manifest-android.md +15 -1
- package/data/uniappx/collocation/manifest.md +1 -0
- package/data/uniappx/component/_sidebar.md +4 -1
- package/data/uniappx/component/ad-drama.md +18 -50
- package/data/uniappx/component/animation-view.md +2 -2
- package/data/uniappx/component/button.md +5 -1
- package/data/uniappx/component/camera.md +2 -2
- package/data/uniappx/component/canvas.md +3 -3
- package/data/uniappx/component/checkbox-group.md +4 -0
- package/data/uniappx/component/checkbox.md +5 -1
- package/data/uniappx/component/common.md +2 -2
- package/data/uniappx/component/editor.md +4 -0
- package/data/uniappx/component/form.md +2 -2
- package/data/uniappx/component/icon.md +2 -0
- package/data/uniappx/component/image.md +7 -2
- package/data/uniappx/component/input.md +2 -2
- package/data/uniappx/component/label.md +4 -0
- package/data/uniappx/component/list-view.md +6 -4
- package/data/uniappx/component/loading.md +4 -4
- package/data/uniappx/component/match-media.md +2 -2
- package/data/uniappx/component/movable-view.md +2 -2
- package/data/uniappx/component/navigation-bar.md +17 -17
- package/data/uniappx/component/navigator.md +12 -12
- package/data/uniappx/component/page-container.md +4 -0
- package/data/uniappx/component/picker-view.md +8 -0
- package/data/uniappx/component/picker.md +16 -16
- package/data/uniappx/component/progress.md +2 -2
- package/data/uniappx/component/radio-group.md +4 -0
- package/data/uniappx/component/radio.md +4 -0
- package/data/uniappx/component/rich-text.md +2 -2
- package/data/uniappx/component/scroll-view.md +5 -5
- package/data/uniappx/component/slider.md +23 -17
- package/data/uniappx/component/sticky-header.md +4 -0
- package/data/uniappx/component/sticky-section.md +4 -0
- package/data/uniappx/component/swiper.md +6 -2
- package/data/uniappx/component/switch.md +4 -0
- package/data/uniappx/component/text.md +8 -8
- package/data/uniappx/component/textarea.md +2 -2
- package/data/uniappx/component/uni-ui-x/README.md +3 -2
- package/data/uniappx/component/uni-ui-x/uni-badge-view.md +4 -0
- package/data/uniappx/component/uni-ui-x/uni-collapse.md +1 -1
- package/data/uniappx/component/uni-ui-x/uni-combox.md +39 -15
- package/data/uniappx/component/uni-ui-x/uni-icons.md +376 -0
- package/data/uniappx/component/uni-ui-x/uni-link.md +1 -1
- package/data/uniappx/component/uni-ui-x/uni-nav-bar.md +1 -1
- package/data/uniappx/component/uni-ui-x/uni-number-box.md +1 -1
- package/data/uniappx/component/uni-ui-x/uni-rate.md +5 -1
- package/data/uniappx/component/uni-ui-x/uni-tab.md +4 -0
- package/data/uniappx/component/unicloud-db.md +5 -5
- package/data/uniappx/component/video.md +3 -3
- package/data/uniappx/component/view.md +2 -0
- package/data/uniappx/component/waterflow.md +8 -2
- package/data/uniappx/component/web-view.md +2 -2
- package/data/uniappx/css/common/at-rules.md +13 -7
- package/data/uniappx/css/common/color.md +9 -9
- package/data/uniappx/css/common/function.md +2 -0
- package/data/uniappx/css/common/length.md +89 -89
- package/data/uniappx/css/common/selector.md +3 -3
- package/data/uniappx/css/visibility.md +8 -3
- package/data/uniappx/i18n.md +29 -29
- package/data/uniappx/mp/README.md +21 -0
- package/data/uniappx/native/download/android.md +14 -60
- package/data/uniappx/native/download/ios.md +5 -5
- package/data/uniappx/native/use/android.md +4 -2
- package/data/uniappx/native/use/androidcomm.md +130 -4
- package/data/uniappx/readme.md +51 -28
- package/data/uniappx/sample.md +57 -14
- package/data/uniappx/select/crossplatform-on-ai.md +470 -0
- package/data/uniappx/select/native-render-and-self-render.md +4 -4
- package/data/uniappx/tutorial/compliance.md +1 -1
- package/data/uniappx/tutorial/debug/devtools.md +16 -6
- package/data/uniappx/uniapptox.md +49 -18
- package/data/uniappx/uniappvsuniappx.md +157 -38
- package/data/uniappx/uts/buildin-object-api/array.md +0 -371
- package/data/uniappx/uts/uts2js.md +1 -1
- package/data/uniappx/vue/README.md +7 -2
- package/data/uniappx/vue/built-in.md +20 -6
- package/data/uniappx/vue/component.md +2 -0
- package/data/uniappx/vue/modifier.md +6 -6
- package/data/uniappx/web/ssr.md +17 -58
- package/data/uniappx-doc-index.json +99 -687
- package/dist/main.mjs +113 -87
- package/package.json +2 -2
- package/data/tmui4x/30./347/273/204/344/273/266/345/272/223//345/261/225/347/244/272/347/273/204/344/273/266//345/257/214/346/226/207/346/234/254 xMarkdown.md" +0 -211
- package/data/uni-app-x-docs/alert.md +0 -79
- package/data/uni-app-x-docs/avatar-group.md +0 -73
- package/data/uni-app-x-docs/badge.md +0 -62
- package/data/uni-app-x-docs/between-time.md +0 -76
- package/data/uni-app-x-docs/button.md +0 -114
- package/data/uni-app-x-docs/calendar-multiple.md +0 -90
- package/data/uni-app-x-docs/cell.md +0 -91
- package/data/uni-app-x-docs/checkbox-group.md +0 -62
- package/data/uni-app-x-docs/checkbox.md +0 -74
- package/data/uni-app-x-docs/circle-progress.md +0 -74
- package/data/uni-app-x-docs/code-input.md +0 -77
- package/data/uni-app-x-docs/col.md +0 -57
- package/data/uni-app-x-docs/collapse-item.md +0 -76
- package/data/uni-app-x-docs/collapse.md +0 -59
- package/data/uni-app-x-docs/countdown.md +0 -79
- package/data/uni-app-x-docs/date-view.md +0 -65
- package/data/uni-app-x-docs/drawer.md +0 -94
- package/data/uni-app-x-docs/dropdown-item.md +0 -68
- package/data/uni-app-x-docs/dropdown-menu.md +0 -70
- package/data/uni-app-x-docs/echart.md +0 -69
- package/data/uni-app-x-docs/float-drawer.md +0 -79
- package/data/uni-app-x-docs/form-item.md +0 -67
- package/data/uni-app-x-docs/form.md +0 -68
- package/data/uni-app-x-docs/html.md +0 -70
- package/data/uni-app-x-docs/icon.md +0 -67
- package/data/uni-app-x-docs/image.md +0 -74
- package/data/uni-app-x-docs/input.md +0 -126
- package/data/uni-app-x-docs/modal.md +0 -92
- package/data/uni-app-x-docs/money.md +0 -70
- package/data/uni-app-x-docs/more.md +0 -69
- package/data/uni-app-x-docs/navbar.md +0 -82
- package/data/uni-app-x-docs/picker-date.md +0 -75
- package/data/uni-app-x-docs/picker-selected.md +0 -75
- package/data/uni-app-x-docs/picker-time.md +0 -77
- package/data/uni-app-x-docs/picker-view.md +0 -70
- package/data/uni-app-x-docs/picker.md +0 -76
- package/data/uni-app-x-docs/popover.md +0 -68
- package/data/uni-app-x-docs/progress.md +0 -72
- package/data/uni-app-x-docs/pull-refresh.md +0 -73
- package/data/uni-app-x-docs/radio-group.md +0 -61
- package/data/uni-app-x-docs/radio.md +0 -74
- package/data/uni-app-x-docs/rate.md +0 -72
- package/data/uni-app-x-docs/row.md +0 -61
- package/data/uni-app-x-docs/sheet.md +0 -72
- package/data/uni-app-x-docs/sign-board.md +0 -61
- package/data/uni-app-x-docs/skeleton.md +0 -60
- package/data/uni-app-x-docs/sku.md +0 -69
- package/data/uni-app-x-docs/slider-double.md +0 -71
- package/data/uni-app-x-docs/slider-menu.md +0 -78
- package/data/uni-app-x-docs/slider.md +0 -71
- package/data/uni-app-x-docs/stepper.md +0 -76
- package/data/uni-app-x-docs/steps-item.md +0 -71
- package/data/uni-app-x-docs/steps.md +0 -73
- package/data/uni-app-x-docs/sticky-header.md +0 -57
- package/data/uni-app-x-docs/sticky.md +0 -55
- package/data/uni-app-x-docs/switch-slider.md +0 -82
- package/data/uni-app-x-docs/switch.md +0 -68
- package/data/uni-app-x-docs/tabbar.md +0 -83
- package/data/uni-app-x-docs/tabs.md +0 -84
- package/data/uni-app-x-docs/tag.md +0 -78
- package/data/uni-app-x-docs/text.md +0 -69
- package/data/uni-app-x-docs/upload-photo.md +0 -86
- package/data/uni-app-x-docs/upload-video.md +0 -86
- package/data/uni-app-x-docs//346/250/241/346/235/277.md +0 -47
- package/data/uniappx/alert.md +0 -61
- package/data/uniappx/avatar-group.md +0 -55
- package/data/uniappx/badge.md +0 -44
- package/data/uniappx/between-time.md +0 -58
- package/data/uniappx/button.md +0 -96
- package/data/uniappx/calendar-multiple.md +0 -72
- package/data/uniappx/cell.md +0 -73
- package/data/uniappx/checkbox-group.md +0 -44
- package/data/uniappx/checkbox.md +0 -56
- package/data/uniappx/circle-progress.md +0 -56
- package/data/uniappx/code-input.md +0 -59
- package/data/uniappx/col.md +0 -39
- package/data/uniappx/collapse-item.md +0 -58
- package/data/uniappx/collapse.md +0 -41
- package/data/uniappx/countdown.md +0 -61
- package/data/uniappx/date-view.md +0 -47
- package/data/uniappx/drawer.md +0 -76
- package/data/uniappx/dropdown-item.md +0 -50
- package/data/uniappx/dropdown-menu.md +0 -52
- package/data/uniappx/echart.md +0 -51
- package/data/uniappx/float-drawer.md +0 -61
- package/data/uniappx/form-item.md +0 -49
- package/data/uniappx/form.md +0 -50
- package/data/uniappx/html.md +0 -52
- package/data/uniappx/icon.md +0 -49
- package/data/uniappx/image.md +0 -56
- package/data/uniappx/input.md +0 -108
- package/data/uniappx/modal.md +0 -74
- package/data/uniappx/money.md +0 -52
- package/data/uniappx/more.md +0 -51
- package/data/uniappx/navbar.md +0 -64
- package/data/uniappx/picker-date.md +0 -57
- package/data/uniappx/picker-selected.md +0 -57
- package/data/uniappx/picker-time.md +0 -59
- package/data/uniappx/picker-view.md +0 -52
- package/data/uniappx/picker.md +0 -58
- package/data/uniappx/popover.md +0 -50
- package/data/uniappx/progress.md +0 -54
- package/data/uniappx/pull-refresh.md +0 -55
- package/data/uniappx/radio-group.md +0 -43
- package/data/uniappx/radio.md +0 -56
- package/data/uniappx/rate.md +0 -54
- package/data/uniappx/row.md +0 -43
- package/data/uniappx/sheet.md +0 -54
- package/data/uniappx/sign-board.md +0 -43
- package/data/uniappx/skeleton.md +0 -42
- package/data/uniappx/sku.md +0 -51
- package/data/uniappx/slider-double.md +0 -53
- package/data/uniappx/slider-menu.md +0 -60
- package/data/uniappx/slider.md +0 -53
- package/data/uniappx/stepper.md +0 -58
- package/data/uniappx/steps-item.md +0 -53
- package/data/uniappx/steps.md +0 -55
- package/data/uniappx/sticky-header.md +0 -39
- package/data/uniappx/sticky.md +0 -37
- package/data/uniappx/switch-slider.md +0 -64
- package/data/uniappx/switch.md +0 -50
- package/data/uniappx/tabbar.md +0 -65
- package/data/uniappx/tabs.md +0 -66
- package/data/uniappx/tag.md +0 -60
- package/data/uniappx/text.md +0 -51
- package/data/uniappx/upload-photo.md +0 -68
- package/data/uniappx/upload-video.md +0 -68
- package/data/uniappx//346/250/241/346/235/277.md +0 -34
|
@@ -3,52 +3,63 @@
|
|
|
3
3
|
|
|
4
4
|
创建短剧广告实例:创建即自动加载短剧模块(自动加载模式),加载结果经 onLoad / onError 上报
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html),需下载插件:[uni-drama](https://ext.dcloud.net.cn/plugin?id=30115)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
短剧广告:通过短剧内容生态 `穿山甲内容联盟(短剧)` 变现的高价值广告形式。将短剧内容(列表)嵌入自己的应用中,用户免费观看指定集数后,需观看激励视频解锁后续剧集,从而实现广告变现。
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
| :- | :- | :- |
|
|
12
|
-
| API 模式 | 通过 `uni.createDramaAd` 创建实例,自行搭建短剧列表页,调用查询接口获取短剧数据,再调用 `open` 打开原生播放页 | 需要自定义短剧列表页样式、深度定制业务 |
|
|
13
|
-
| 组件模式 | 使用 `<ad-drama>` 组件(native-view)| 快速接入,直接使用渠道提供的短剧首页 |
|
|
10
|
+
通过 uni.createDramaAd 可实现 API 模式接入方式: 调用查询接口获取短剧数据,自定义实现短剧列表界面,用户点击后通过 `open` 打开短剧播放界面。如需快速接入,请使用([ad-drama](../component/ad-drama.md))组件模式接入。
|
|
14
11
|
|
|
15
|
-
|
|
16
|
-
示例Demo
|
|
12
|
+
- uni-ad的业务介绍:[详见](https://uniapp.dcloud.net.cn/uni-ad/)
|
|
13
|
+
- 示例Demo:[详见](https://gitcode.com/dcloud/uni-ad-drama)
|
|
17
14
|
|
|
18
15
|
**开通配置广告**
|
|
19
16
|
|
|
20
17
|
[开通广告步骤详情](https://uniapp.dcloud.net.cn/uni-ad/ad-open.html)
|
|
21
18
|
|
|
22
19
|
**Tips**
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
20
|
+
- HBuilder 5.32 版本 app-android 平台支持。
|
|
21
|
+
- 使用短剧组件需要先开通穿山甲广告,相关问题请咨询:[uni-ad交流群](https://im.dcloud.net.cn/#/?joinGroup=65d85fc09847e92db03ff81a)。
|
|
22
|
+
- 标准基座不包含短剧功能,需勾选广告联盟中的“穿山甲内容联盟(短剧)”,打包自定义基座后运行,否则报错 `-5020` 错误。
|
|
26
23
|
|
|
27
24
|
### 配置文件
|
|
28
25
|
|
|
29
|
-
|
|
26
|
+
短剧功能使用的“穿山甲内容联盟(短剧)”要求配置 `SDK参数配置` 文件,在穿山甲后台 "内容输出" -> "接入管理" 找到需要接入内容SDK的应用,点击"下载SDK参数配置":
|
|
30
27
|
|
|
31
28
|

|
|
32
29
|
|
|
33
|
-
|
|
30
|
+
配置文件下载之后重命名为 `gm_SDK_Setting.json`,然后将文件放到到 uni-app x 项目的 `nativeResources\android\assets` 文件夹中。
|
|
34
31
|
|
|
35
32
|
### 服务器回调
|
|
36
33
|
|
|
37
|
-
|
|
34
|
+
短剧的变现逻辑是:用户免费看完前面几集后,需要看一段激励视频才能解锁后续剧集。这里有一个关键的安全问题——"用户到底有没有真的看完广告",这件事不能听客户端的。
|
|
35
|
+
|
|
36
|
+
客户端播放结束时的结果(如 `isEnded`)只是本地状态,很容易被黑产通过反编译、抓包伪造请求来冒充。如果直接按客户端上报来解锁,攻击者可以一次广告都不看就骗取解锁,而广告平台那边并没有真正产生广告收入,最后是开发者既赔了内容又拿不到钱。
|
|
37
|
+
|
|
38
|
+
所以,解锁集数的发放必须由服务器回调来完成:用户完整看完激励视频后,广告平台会通知 uni-ad,uni-ad 再通过 uniCloud 把"这次广告确实看完了"的可信消息发送到开发者自己的业务服务器,由业务服务器来发放解锁。这条链路黑产无法伪造,是业内通行的安全方案(支付回调同理),没有配置服务器回调的解锁是不安全的。
|
|
39
|
+
|
|
40
|
+
接入步骤:
|
|
41
|
+
|
|
42
|
+
1. 在 uni-ad 后台为短剧广告位开启激励视频服务器回调,并选择业务所在位置:业务在 uniCloud 则选云函数/云对象;业务在传统服务器则配置回调 URL。
|
|
43
|
+
2. 调用 `open` 时传入 `urlCallback`,用于把业务身份带给服务器:
|
|
44
|
+
- `userId`:用户唯一标识,服务器据此知道该给谁解锁;
|
|
45
|
+
- `extra`:业务自定义参数,例如本次要解锁的剧集 ID、订单号等,回调时原样回传。
|
|
46
|
+
3. 业务服务器收到回调后,按 `userId` / `extra` 校验并解锁对应集数。客户端不要自行解锁,只根据服务器结果刷新界面。
|
|
47
|
+
|
|
48
|
+
服务器回调的详细机制、回调参数、签名校验和完整配置流程,详见 [激励视频广告服务器回调](https://uniapp.dcloud.net.cn/uni-ad/ad-rewarded-video.html#callback)。
|
|
38
49
|
|
|
39
50
|
### createDramaAd 兼容性
|
|
40
|
-
| Web | 微信小程序 | 支付宝小程序 | Android |
|
|
41
|
-
| :- | :- | :- | :- |
|
|
42
|
-
| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 5.
|
|
51
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
52
|
+
| :- | :- | :- | :- | :- | :- |
|
|
53
|
+
| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 5.32 | √ | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
|
|
43
54
|
|
|
44
55
|
### 参数
|
|
45
56
|
|
|
46
57
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
47
58
|
| :- | :- | :- | :-: | :- |
|
|
48
|
-
| options | **CreateDramaAdOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x
|
|
59
|
+
| options | **CreateDramaAdOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 用于创建短剧广告(DramaAd)实例时传入的配置项类型,目前仅包含必填的 adpid |
|
|
49
60
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
50
61
|
| :- | :- | :- | :-: | :- |
|
|
51
|
-
| adpid | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
62
|
+
| adpid | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧广告位标识<br/>必填;在 uni-ad 平台申请短剧广告位获取的 adpid。<br/>adpid 为空、无效或广告位未开通时,创建后经 onError 上报 -5001 / -5002 / -5003。 |
|
|
52
63
|
|
|
53
64
|
### 返回值
|
|
54
65
|
|
|
@@ -60,562 +71,741 @@ uni-app x 内置短剧 uni-drama,提供两种接入方式:
|
|
|
60
71
|
|
|
61
72
|
#### getList(options : DramaListOptions) : void @getlist
|
|
62
73
|
getList
|
|
63
|
-
|
|
64
|
-
如恢复手动加载模式,放开下面声明并同步放开实现处的注释)。
|
|
74
|
+
获取短剧列表,用于自建聚合页渲染;分页参数 page 从 1 开始,结果经 options.success / options.fail 回调返回
|
|
65
75
|
##### getList 兼容性
|
|
66
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
67
|
-
| :- | :- | :- |
|
|
68
|
-
| x | x | x |
|
|
76
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
77
|
+
| :- | :- | :- | :- | :- | :- |
|
|
78
|
+
| x | x | x | 5.32 | √ | x |
|
|
69
79
|
|
|
70
80
|
##### 参数
|
|
71
81
|
|
|
72
82
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
73
83
|
| :- | :- | :- | :-: | :- |
|
|
74
|
-
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
84
|
+
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表查询参数(getList / getRecommendedList / getCollectionList / getHistoryList 通用) page 从 1 开始、pageSize 默认 20;查询结果经 success / fail / complete 回调返回。 |
|
|
75
85
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
76
86
|
| :- | :- | :- | :-: | :- |
|
|
77
|
-
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
78
|
-
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
79
|
-
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
80
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询成功的回调函数 |
|
|
81
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询失败的回调函数 |
|
|
82
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
87
|
+
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 页码,从 1 开始;不传默认 1 |
|
|
88
|
+
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 每页短剧数量;不传默认 20 |
|
|
89
|
+
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表排序方式;不传默认 "default"。<br/>仅 getList 生效:推荐列表(getRecommendedList)、收藏列表(getCollectionList)、观看历史(getHistoryList)忽略该参数 |
|
|
90
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询成功的回调函数 |
|
|
91
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询失败的回调函数 |
|
|
92
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
83
93
|
|
|
84
94
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
85
95
|
|
|
86
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
87
|
-
| :- | :- | :- | :-: |
|
|
88
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
89
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
90
|
-
| :- | :- | :- | :-: |
|
|
91
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
92
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
93
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
94
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
95
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
96
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
97
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
98
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
99
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
100
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
101
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
102
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
103
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
104
|
-
| extra | UTSJSONObject | 是 | |
|
|
96
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
97
|
+
| :- | :- | :- | :-: | :- |
|
|
98
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
99
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
100
|
+
| :- | :- | :- | :-: | :- |
|
|
101
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
102
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
103
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
104
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
105
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
106
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
107
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
108
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
109
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
110
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
111
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
112
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
113
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
114
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
105
115
|
|
|
106
116
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
107
117
|
|
|
108
118
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
109
119
|
| :- | :- | :- | :-: | :- |
|
|
110
|
-
| errCode |
|
|
111
|
-
|
|
|
112
|
-
|
|
|
120
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
121
|
+
| 合法值 | 兼容性 | 描述 |
|
|
122
|
+
| :- | :-: | :- |
|
|
123
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
124
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
125
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
126
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
127
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
128
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
129
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
130
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
131
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
132
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
133
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
134
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
135
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
136
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
137
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
138
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
139
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
140
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
141
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
142
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
113
143
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
114
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
144
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
115
145
|
|
|
116
146
|
#### getRecommendedList(options : DramaListOptions) : void @getrecommendedlist
|
|
117
147
|
getRecommendedList
|
|
118
|
-
|
|
148
|
+
分页获取推荐短剧列表,结果经 options.success / options.fail 回调返回
|
|
119
149
|
##### getRecommendedList 兼容性
|
|
120
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
121
|
-
| :- | :- | :- |
|
|
122
|
-
| x | x | x |
|
|
150
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
151
|
+
| :- | :- | :- | :- | :- | :- |
|
|
152
|
+
| x | x | x | 5.32 | √ | x |
|
|
123
153
|
|
|
124
154
|
##### 参数
|
|
125
155
|
|
|
126
156
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
127
157
|
| :- | :- | :- | :-: | :- |
|
|
128
|
-
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
158
|
+
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表查询参数(getList / getRecommendedList / getCollectionList / getHistoryList 通用) page 从 1 开始、pageSize 默认 20;查询结果经 success / fail / complete 回调返回。 |
|
|
129
159
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
130
160
|
| :- | :- | :- | :-: | :- |
|
|
131
|
-
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
132
|
-
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
133
|
-
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
134
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询成功的回调函数 |
|
|
135
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询失败的回调函数 |
|
|
136
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
161
|
+
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 页码,从 1 开始;不传默认 1 |
|
|
162
|
+
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 每页短剧数量;不传默认 20 |
|
|
163
|
+
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表排序方式;不传默认 "default"。<br/>仅 getList 生效:推荐列表(getRecommendedList)、收藏列表(getCollectionList)、观看历史(getHistoryList)忽略该参数 |
|
|
164
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询成功的回调函数 |
|
|
165
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询失败的回调函数 |
|
|
166
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
137
167
|
|
|
138
168
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
139
169
|
|
|
140
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
141
|
-
| :- | :- | :- | :-: |
|
|
142
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
143
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
144
|
-
| :- | :- | :- | :-: |
|
|
145
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
146
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
147
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
148
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
149
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
150
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
151
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
152
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
153
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
154
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
155
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
156
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
157
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
158
|
-
| extra | UTSJSONObject | 是 | |
|
|
170
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
171
|
+
| :- | :- | :- | :-: | :- |
|
|
172
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
173
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
174
|
+
| :- | :- | :- | :-: | :- |
|
|
175
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
176
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
177
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
178
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
179
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
180
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
181
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
182
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
183
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
184
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
185
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
186
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
187
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
188
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
159
189
|
|
|
160
190
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
161
191
|
|
|
162
192
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
163
193
|
| :- | :- | :- | :-: | :- |
|
|
164
|
-
| errCode |
|
|
165
|
-
|
|
|
166
|
-
|
|
|
194
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
195
|
+
| 合法值 | 兼容性 | 描述 |
|
|
196
|
+
| :- | :-: | :- |
|
|
197
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
198
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
199
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
200
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
201
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
202
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
203
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
204
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
205
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
206
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
207
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
208
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
209
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
210
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
211
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
212
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
213
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
214
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
215
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
216
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
167
217
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
168
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
218
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
169
219
|
|
|
170
220
|
#### getCollectionList(options : DramaListOptions) : void @getcollectionlist
|
|
171
221
|
getCollectionList
|
|
172
|
-
|
|
222
|
+
分页获取用户收藏的短剧列表,结果经 options.success / options.fail 回调返回
|
|
173
223
|
##### getCollectionList 兼容性
|
|
174
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
175
|
-
| :- | :- | :- |
|
|
176
|
-
| x | x | x |
|
|
224
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
225
|
+
| :- | :- | :- | :- | :- | :- |
|
|
226
|
+
| x | x | x | 5.32 | √ | x |
|
|
177
227
|
|
|
178
228
|
##### 参数
|
|
179
229
|
|
|
180
230
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
181
231
|
| :- | :- | :- | :-: | :- |
|
|
182
|
-
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
232
|
+
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表查询参数(getList / getRecommendedList / getCollectionList / getHistoryList 通用) page 从 1 开始、pageSize 默认 20;查询结果经 success / fail / complete 回调返回。 |
|
|
183
233
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
184
234
|
| :- | :- | :- | :-: | :- |
|
|
185
|
-
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
186
|
-
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
187
|
-
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
188
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询成功的回调函数 |
|
|
189
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询失败的回调函数 |
|
|
190
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
235
|
+
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 页码,从 1 开始;不传默认 1 |
|
|
236
|
+
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 每页短剧数量;不传默认 20 |
|
|
237
|
+
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表排序方式;不传默认 "default"。<br/>仅 getList 生效:推荐列表(getRecommendedList)、收藏列表(getCollectionList)、观看历史(getHistoryList)忽略该参数 |
|
|
238
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询成功的回调函数 |
|
|
239
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询失败的回调函数 |
|
|
240
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
191
241
|
|
|
192
242
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
193
243
|
|
|
194
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
195
|
-
| :- | :- | :- | :-: |
|
|
196
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
197
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
198
|
-
| :- | :- | :- | :-: |
|
|
199
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
200
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
201
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
202
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
203
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
204
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
205
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
206
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
207
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
208
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
209
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
210
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
211
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
212
|
-
| extra | UTSJSONObject | 是 | |
|
|
244
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
245
|
+
| :- | :- | :- | :-: | :- |
|
|
246
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
247
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
248
|
+
| :- | :- | :- | :-: | :- |
|
|
249
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
250
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
251
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
252
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
253
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
254
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
255
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
256
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
257
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
258
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
259
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
260
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
261
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
262
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
213
263
|
|
|
214
264
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
215
265
|
|
|
216
266
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
217
267
|
| :- | :- | :- | :-: | :- |
|
|
218
|
-
| errCode |
|
|
219
|
-
|
|
|
220
|
-
|
|
|
268
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
269
|
+
| 合法值 | 兼容性 | 描述 |
|
|
270
|
+
| :- | :-: | :- |
|
|
271
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
272
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
273
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
274
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
275
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
276
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
277
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
278
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
279
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
280
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
281
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
282
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
283
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
284
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
285
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
286
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
287
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
288
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
289
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
290
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
221
291
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
222
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
292
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
223
293
|
|
|
224
294
|
#### getHistoryList(options : DramaListOptions) : void @gethistorylist
|
|
225
295
|
getHistoryList
|
|
226
|
-
|
|
296
|
+
分页获取用户观看记录的短剧列表,结果经 options.success / options.fail 回调返回
|
|
227
297
|
##### getHistoryList 兼容性
|
|
228
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
229
|
-
| :- | :- | :- |
|
|
230
|
-
| x | x | x |
|
|
298
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
299
|
+
| :- | :- | :- | :- | :- | :- |
|
|
300
|
+
| x | x | x | 5.32 | √ | x |
|
|
231
301
|
|
|
232
302
|
##### 参数
|
|
233
303
|
|
|
234
304
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
235
305
|
| :- | :- | :- | :-: | :- |
|
|
236
|
-
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
306
|
+
| options | **DramaListOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表查询参数(getList / getRecommendedList / getCollectionList / getHistoryList 通用) page 从 1 开始、pageSize 默认 20;查询结果经 success / fail / complete 回调返回。 |
|
|
237
307
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
238
308
|
| :- | :- | :- | :-: | :- |
|
|
239
|
-
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
240
|
-
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
241
|
-
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
242
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询成功的回调函数 |
|
|
243
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询失败的回调函数 |
|
|
244
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
309
|
+
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 页码,从 1 开始;不传默认 1 |
|
|
310
|
+
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 每页短剧数量;不传默认 20 |
|
|
311
|
+
| order | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 列表排序方式;不传默认 "default"。<br/>仅 getList 生效:推荐列表(getRecommendedList)、收藏列表(getCollectionList)、观看历史(getHistoryList)忽略该参数 |
|
|
312
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询成功的回调函数 |
|
|
313
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询失败的回调函数 |
|
|
314
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
245
315
|
|
|
246
316
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
247
317
|
|
|
248
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
249
|
-
| :- | :- | :- | :-: |
|
|
250
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
251
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
252
|
-
| :- | :- | :- | :-: |
|
|
253
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
254
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
255
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
256
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
257
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
258
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
259
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
260
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
261
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
262
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
263
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
264
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
265
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
266
|
-
| extra | UTSJSONObject | 是 | |
|
|
318
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
319
|
+
| :- | :- | :- | :-: | :- |
|
|
320
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
321
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
322
|
+
| :- | :- | :- | :-: | :- |
|
|
323
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
324
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
325
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
326
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
327
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
328
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
329
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
330
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
331
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
332
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
333
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
334
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
335
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
336
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
267
337
|
|
|
268
338
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
269
339
|
|
|
270
340
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
271
341
|
| :- | :- | :- | :-: | :- |
|
|
272
|
-
| errCode |
|
|
273
|
-
|
|
|
274
|
-
|
|
|
342
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
343
|
+
| 合法值 | 兼容性 | 描述 |
|
|
344
|
+
| :- | :-: | :- |
|
|
345
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
346
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
347
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
348
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
349
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
350
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
351
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
352
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
353
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
354
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
355
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
356
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
357
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
358
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
359
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
360
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
361
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
362
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
363
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
364
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
275
365
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
276
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
366
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
277
367
|
|
|
278
368
|
#### search(options : DramaSearchOptions) : void @search
|
|
279
369
|
search
|
|
280
|
-
|
|
370
|
+
根据关键词搜索短剧,isFuzzy 为 true 时模糊匹配(默认 true),结果经 options.success / options.fail 回调返回
|
|
281
371
|
##### search 兼容性
|
|
282
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
283
|
-
| :- | :- | :- |
|
|
284
|
-
| x | x | x |
|
|
372
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
373
|
+
| :- | :- | :- | :- | :- | :- |
|
|
374
|
+
| x | x | x | 5.32 | √ | x |
|
|
285
375
|
|
|
286
376
|
##### 参数
|
|
287
377
|
|
|
288
378
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
289
379
|
| :- | :- | :- | :-: | :- |
|
|
290
|
-
| options | **DramaSearchOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
380
|
+
| options | **DramaSearchOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | search 搜索参数 searchWord 必填;isFuzzy 默认 true(模糊匹配);搜索结果经 success / fail / complete 回调返回。 |
|
|
291
381
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
292
382
|
| :- | :- | :- | :-: | :- |
|
|
293
|
-
| searchWord | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
294
|
-
| isFuzzy | boolean | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
295
|
-
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
296
|
-
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
297
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 搜索成功的回调函数 |
|
|
298
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 搜索失败的回调函数 |
|
|
299
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 搜索结束的回调函数(成功失败都会执行) |
|
|
383
|
+
| searchWord | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 搜索关键词,必填 |
|
|
384
|
+
| isFuzzy | boolean | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 是否模糊匹配;不传默认 true(模糊匹配) |
|
|
385
|
+
| page | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 页码,从 1 开始;不传默认 1 |
|
|
386
|
+
| pageSize | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 每页短剧数量;不传默认 20 |
|
|
387
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 搜索成功的回调函数 |
|
|
388
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 搜索失败的回调函数 |
|
|
389
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 搜索结束的回调函数(成功失败都会执行) |
|
|
300
390
|
|
|
301
391
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
302
392
|
|
|
303
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
304
|
-
| :- | :- | :- | :-: |
|
|
305
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
306
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
307
|
-
| :- | :- | :- | :-: |
|
|
308
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
309
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
310
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
311
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
312
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
313
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
314
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
315
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
316
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
317
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
318
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
319
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
320
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
321
|
-
| extra | UTSJSONObject | 是 | |
|
|
393
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
394
|
+
| :- | :- | :- | :-: | :- |
|
|
395
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
396
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
397
|
+
| :- | :- | :- | :-: | :- |
|
|
398
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
399
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
400
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
401
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
402
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
403
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
404
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
405
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
406
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
407
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
408
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
409
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
410
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
411
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
322
412
|
|
|
323
413
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
324
414
|
|
|
325
415
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
326
416
|
| :- | :- | :- | :-: | :- |
|
|
327
|
-
| errCode |
|
|
328
|
-
|
|
|
329
|
-
|
|
|
417
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
418
|
+
| 合法值 | 兼容性 | 描述 |
|
|
419
|
+
| :- | :-: | :- |
|
|
420
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
421
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
422
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
423
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
424
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
425
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
426
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
427
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
428
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
429
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
430
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
431
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
432
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
433
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
434
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
435
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
436
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
437
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
438
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
439
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
330
440
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
331
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
441
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
332
442
|
|
|
333
443
|
#### getInfo(options : DramaInfoOptions) : void @getinfo
|
|
334
444
|
getInfo
|
|
335
|
-
|
|
445
|
+
获取指定短剧信息,参数 dramaId 与 dramaIds 二选一,结果经 options.success / options.fail 回调返回
|
|
336
446
|
##### getInfo 兼容性
|
|
337
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
338
|
-
| :- | :- | :- |
|
|
339
|
-
| x | x | x |
|
|
447
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
448
|
+
| :- | :- | :- | :- | :- | :- |
|
|
449
|
+
| x | x | x | 5.32 | √ | x |
|
|
340
450
|
|
|
341
451
|
##### 参数
|
|
342
452
|
|
|
343
453
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
344
454
|
| :- | :- | :- | :-: | :- |
|
|
345
|
-
| options | **DramaInfoOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
455
|
+
| options | **DramaInfoOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | getInfo 查询参数 dramaId / dramaIds 二选一,同时传入时优先 dramaIds;查询结果经 success / fail / complete 回调返回。 |
|
|
346
456
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
347
457
|
| :- | :- | :- | :-: | :- |
|
|
348
|
-
| dramaId | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
349
|
-
| dramaIds | Array<number> | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
350
|
-
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询成功的回调函数 |
|
|
351
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询失败的回调函数 |
|
|
352
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
458
|
+
| dramaId | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 单个短剧 ID;与 dramaIds 二选一,两者同时传入时优先使用 dramaIds |
|
|
459
|
+
| dramaIds | Array<number> | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 批量短剧 ID 列表;与 dramaId 二选一,两者同时传入时优先使用 dramaIds |
|
|
460
|
+
| success | (res: [DramaListResult](#dramalistresult-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询成功的回调函数 |
|
|
461
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询失败的回调函数 |
|
|
462
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 查询结束的回调函数(成功失败都会执行) |
|
|
353
463
|
|
|
354
464
|
###### DramaListResult 的属性值 @dramalistresult-values
|
|
355
465
|
|
|
356
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
357
|
-
| :- | :- | :- | :-: |
|
|
358
|
-
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
359
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
360
|
-
| :- | :- | :- | :-: |
|
|
361
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
362
|
-
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
363
|
-
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
364
|
-
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
365
|
-
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
366
|
-
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
367
|
-
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
368
|
-
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
369
|
-
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
370
|
-
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
371
|
-
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
372
|
-
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
373
|
-
| rawInfo | UTSJSONObject | 否 | |
|
|
374
|
-
| extra | UTSJSONObject | 是 | |
|
|
466
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
467
|
+
| :- | :- | :- | :-: | :- |
|
|
468
|
+
| dramas | Array<**DramaInfo**> | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页短剧列表 |
|
|
469
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
470
|
+
| :- | :- | :- | :-: | :- |
|
|
471
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧唯一标识(统一为 string,由渠道原始 ID 转换而来) |
|
|
472
|
+
| title | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧标题 |
|
|
473
|
+
| coverUrl | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 封面图片 URL |
|
|
474
|
+
| desc | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧简介 |
|
|
475
|
+
| categoryId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类 ID |
|
|
476
|
+
| categoryName | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分类名称 |
|
|
477
|
+
| currentEpisode | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前观看到的集数 |
|
|
478
|
+
| totalEpisodes | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧总集数 |
|
|
479
|
+
| groupId | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 分组 ID(渠道侧的短剧分组/专辑标识) |
|
|
480
|
+
| unlockIndex | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 已解锁集数索引(当前可观看进度) |
|
|
481
|
+
| styleType | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 样式类型标识,取值由渠道定义 |
|
|
482
|
+
| duration | number | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧时长(单位由渠道定义,通常为秒) |
|
|
483
|
+
| rawInfo | UTSJSONObject | 否 | | 渠道原始数据(短剧信息的原始 JSON 快照),可能为 null;<br/>字段可能因渠道差异,业务侧做好空值兼容 |
|
|
484
|
+
| extra | UTSJSONObject | 是 | | 渠道扩展信息(如分页游标等),无扩展数据时为空对象 |
|
|
375
485
|
|
|
376
486
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
377
487
|
|
|
378
488
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
379
489
|
| :- | :- | :- | :-: | :- |
|
|
380
|
-
| errCode |
|
|
381
|
-
|
|
|
382
|
-
|
|
|
490
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
491
|
+
| 合法值 | 兼容性 | 描述 |
|
|
492
|
+
| :- | :-: | :- |
|
|
493
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
494
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
495
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
496
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
497
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
498
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
499
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
500
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
501
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
502
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
503
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
504
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
505
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
506
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
507
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
508
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
509
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
510
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
511
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
512
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
383
513
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
384
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
514
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
385
515
|
|
|
386
516
|
#### open(options : DramaOpenOptions) : void @open
|
|
387
517
|
open
|
|
388
|
-
|
|
518
|
+
打开短剧播放页播放指定短剧;支持起播集数 episode、单次激励视频解锁集数 lock、初始免费观看集数 free 与服务端回调透传 urlCallback,结果经 options.success / options.fail 回调返回
|
|
389
519
|
##### open 兼容性
|
|
390
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
391
|
-
| :- | :- | :- |
|
|
392
|
-
| x | x | x |
|
|
520
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
521
|
+
| :- | :- | :- | :- | :- | :- |
|
|
522
|
+
| x | x | x | 5.32 | √ | x |
|
|
393
523
|
|
|
394
524
|
##### 参数
|
|
395
525
|
|
|
396
526
|
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
397
527
|
| :- | :- | :- | :-: | :- |
|
|
398
|
-
| options | **DramaOpenOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
528
|
+
| options | **DramaOpenOptions** | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | open 打开短剧播放页参数 free 初始免费观看集数、lock 单次激励视频可解锁的集数;打开结果经 success / fail / complete 回调返回。 |
|
|
399
529
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
400
530
|
| :- | :- | :- | :-: | :- |
|
|
401
|
-
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 短剧 ID(与 DramaInfo.dramaId 一致,统一为 string) |
|
|
402
|
-
| episode | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 起播集数,默认 1 |
|
|
403
|
-
| lock | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 单次激励视频解锁的集数,默认 1 |
|
|
404
|
-
| free | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 初始免费观看集数,默认 1 |
|
|
405
|
-
| urlCallback | **DramaUrlCallback** | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 服务端回调透传参数:激励发放时回传服务器校验。 |
|
|
406
|
-
@@| 名称 | 类型 | 必备 | 兼容性 |
|
|
407
|
-
@@| :- | :- | :- | :-: |
|
|
408
|
-
@@| userId | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
409
|
-
@@| extra | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
410
|
-
| success | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 播放页打开成功的回调函数 |
|
|
411
|
-
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 播放页打开失败的回调函数 |
|
|
412
|
-
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | 打开结束的回调函数(成功失败都会执行) |
|
|
531
|
+
| dramaId | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧 ID(与 DramaInfo.dramaId 一致,统一为 string) |
|
|
532
|
+
| episode | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 起播集数,默认 1 |
|
|
533
|
+
| lock | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 单次激励视频解锁的集数,默认 1 |
|
|
534
|
+
| free | number | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 初始免费观看集数,默认 1 |
|
|
535
|
+
| urlCallback | **DramaUrlCallback** | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 服务端回调透传参数:激励发放时回传服务器校验。 |
|
|
536
|
+
@@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
537
|
+
@@| :- | :- | :- | :-: | :- |
|
|
538
|
+
@@| userId | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 用户唯一标识:激励视频解锁发放时,用于服务端回调校验;不传则不透传 |
|
|
539
|
+
@@| extra | string | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 服务端回调透传的附加参数(业务自定义,回调时原样回传);不传则不透传 |
|
|
540
|
+
| success | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放页打开成功的回调函数 |
|
|
541
|
+
| fail | (err: [IUniDramaError](#iunidramaerror-values)) => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放页打开失败的回调函数 |
|
|
542
|
+
| complete | () => void | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 打开结束的回调函数(成功失败都会执行) |
|
|
413
543
|
|
|
414
544
|
###### IUniDramaError 的属性值 @iunidramaerror-values
|
|
415
545
|
|
|
416
546
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
417
547
|
| :- | :- | :- | :-: | :- |
|
|
418
|
-
| errCode |
|
|
419
|
-
|
|
|
420
|
-
|
|
|
548
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
549
|
+
| 合法值 | 兼容性 | 描述 |
|
|
550
|
+
| :- | :-: | :- |
|
|
551
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
552
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
553
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
554
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
555
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
556
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
557
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
558
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
559
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
560
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
561
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
562
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
563
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
564
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
565
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
566
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
567
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
568
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
569
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
570
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
421
571
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
422
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
572
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
423
573
|
|
|
424
574
|
#### destroy() : void @destroy
|
|
425
575
|
destroy
|
|
426
|
-
|
|
576
|
+
销毁短剧广告实例并释放资源;API 模式请在页面 onUnmounted 时调用
|
|
427
577
|
##### destroy 兼容性
|
|
428
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
429
|
-
| :- | :- | :- |
|
|
430
|
-
| x | x | x |
|
|
578
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
579
|
+
| :- | :- | :- | :- | :- | :- |
|
|
580
|
+
| x | x | x | 5.32 | √ | x |
|
|
431
581
|
|
|
432
582
|
#### onLoad(callback : DramaSimpleCallback) : void @onload
|
|
433
583
|
onLoad
|
|
434
|
-
|
|
584
|
+
短剧模块加载成功时触发(res.providerType 为渠道类型);open() 打开的播放页就绪后会再次触发(res.type 为 "detail" 并携带 dramaId)
|
|
435
585
|
##### onLoad 兼容性
|
|
436
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
437
|
-
| :- | :- | :- |
|
|
438
|
-
| x | x | x |
|
|
586
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
587
|
+
| :- | :- | :- | :- | :- | :- |
|
|
588
|
+
| x | x | x | 5.32 | √ | x |
|
|
439
589
|
|
|
440
590
|
##### 参数
|
|
441
591
|
|
|
442
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
443
|
-
| :- | :- | :- | :-: |
|
|
444
|
-
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
592
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
593
|
+
| :- | :- | :- | :-: | :- |
|
|
594
|
+
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 简单事件回调,res 为事件数据对象(模块加载成功时含 providerType;播放页就绪时含 type / dramaId) |
|
|
445
595
|
|
|
446
596
|
#### offLoad(callback : DramaSimpleCallback) : void @offload
|
|
447
597
|
offLoad
|
|
448
|
-
|
|
598
|
+
取消 onLoad(callback) 注册的监听
|
|
449
599
|
##### offLoad 兼容性
|
|
450
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
451
|
-
| :- | :- | :- |
|
|
452
|
-
| x | x | x |
|
|
600
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
601
|
+
| :- | :- | :- | :- | :- | :- |
|
|
602
|
+
| x | x | x | 5.32 | √ | x |
|
|
453
603
|
|
|
454
604
|
##### 参数
|
|
455
605
|
|
|
456
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
457
|
-
| :- | :- | :- | :-: |
|
|
458
|
-
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
606
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
607
|
+
| :- | :- | :- | :-: | :- |
|
|
608
|
+
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 简单事件回调,res 为事件数据对象(模块加载成功时含 providerType;播放页就绪时含 type / dramaId) |
|
|
459
609
|
|
|
460
610
|
#### onError(callback : DramaErrorCallback) : void @onerror
|
|
461
611
|
onError
|
|
462
|
-
|
|
612
|
+
发生错误时触发(模块加载失败、查询前置校验失败等),回调参数为 IUniDramaError(errCode / errMsg)
|
|
463
613
|
##### onError 兼容性
|
|
464
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
465
|
-
| :- | :- | :- |
|
|
466
|
-
| x | x | x |
|
|
614
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
615
|
+
| :- | :- | :- | :- | :- | :- |
|
|
616
|
+
| x | x | x | 5.32 | √ | x |
|
|
467
617
|
|
|
468
618
|
##### 参数
|
|
469
619
|
|
|
470
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
471
|
-
| :- | :- | :- | :-: |
|
|
472
|
-
| callback | (err: [IUniDramaError](#iunidramaerror-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
620
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
621
|
+
| :- | :- | :- | :-: | :- |
|
|
622
|
+
| callback | (err: [IUniDramaError](#iunidramaerror-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误回调,err 为 IUniDramaError(errCode 错误码 / errMsg 错误描述) |
|
|
473
623
|
|
|
474
624
|
##### IUniDramaError 的属性值 @iunidramaerror-values
|
|
475
625
|
|
|
476
626
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
477
627
|
| :- | :- | :- | :-: | :- |
|
|
478
|
-
| errCode |
|
|
479
|
-
|
|
|
480
|
-
|
|
|
628
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
629
|
+
| 合法值 | 兼容性 | 描述 |
|
|
630
|
+
| :- | :-: | :- |
|
|
631
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
632
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
633
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
634
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
635
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
636
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
637
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
638
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
639
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
640
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
641
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
642
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
643
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
644
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
645
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
646
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
647
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
648
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
649
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
650
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
481
651
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
482
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
652
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
483
653
|
|
|
484
654
|
#### offError(callback : DramaErrorCallback) : void @offerror
|
|
485
655
|
offError
|
|
486
|
-
|
|
656
|
+
取消 onError(callback) 注册的监听
|
|
487
657
|
##### offError 兼容性
|
|
488
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
489
|
-
| :- | :- | :- |
|
|
490
|
-
| x | x | x |
|
|
658
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
659
|
+
| :- | :- | :- | :- | :- | :- |
|
|
660
|
+
| x | x | x | 5.32 | √ | x |
|
|
491
661
|
|
|
492
662
|
##### 参数
|
|
493
663
|
|
|
494
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
495
|
-
| :- | :- | :- | :-: |
|
|
496
|
-
| callback | (err: [IUniDramaError](#iunidramaerror-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
664
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
665
|
+
| :- | :- | :- | :-: | :- |
|
|
666
|
+
| callback | (err: [IUniDramaError](#iunidramaerror-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误回调,err 为 IUniDramaError(errCode 错误码 / errMsg 错误描述) |
|
|
497
667
|
|
|
498
668
|
##### IUniDramaError 的属性值 @iunidramaerror-values
|
|
499
669
|
|
|
500
670
|
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
501
671
|
| :- | :- | :- | :-: | :- |
|
|
502
|
-
| errCode |
|
|
503
|
-
|
|
|
504
|
-
|
|
|
672
|
+
| errCode | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧错误码 |
|
|
673
|
+
| 合法值 | 兼容性 | 描述 |
|
|
674
|
+
| :- | :-: | :- |
|
|
675
|
+
| -5001 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | adpid 为空:创建实例时未传入短剧广告位标识——传入在 uni-ad 后台申请的 adpid |
|
|
676
|
+
| -5002 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 无效的 adpid 或短剧容器未就绪:核对 adpid 是否正确、组件是否完成挂载 |
|
|
677
|
+
| -5003 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告位未开通:在 uni-ad 后台申请短剧广告位并确保审核通过 |
|
|
678
|
+
| -5005 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告加载失败:网络异常或当前无广告填充——稍后重试 |
|
|
679
|
+
| -5006 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告已展示过:需重新加载后才能再次展示 |
|
|
680
|
+
| -5007 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 未获取到广告配置:请检查广告是否开启,或 appid 与广告后台是否一致 |
|
|
681
|
+
| -5008 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告不可用或已过期:广告素材失效——重新发起请求 |
|
|
682
|
+
| -5009 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告类型不符:adpid 对应的广告类型与请求不符——核对后台申请的广告位类型 |
|
|
683
|
+
| -5010 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面缺失或已销毁:页面未就绪时发起创建/请求——请在页面存活期间调用 |
|
|
684
|
+
| -5011 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧实例已销毁:destroy() 后仍调用实例方法——重新 uni.createDramaAd 创建实例 |
|
|
685
|
+
| -5012 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧模块未加载完成:onLoad 触发前调用了查询方法——注册 onLoad 监听,模块就绪后再查询 |
|
|
686
|
+
| -5013 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告播放失败:素材下载或播放异常——重新加载 |
|
|
687
|
+
| -5015 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 当前页面环境不支持承载短剧页面——常规 uni-app x 页面不会出现,如遇到请反馈问题 |
|
|
688
|
+
| -5016 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧首页/详情页创建失败:渠道页面创建异常——重试,持续失败请检查基座与包名配置 |
|
|
689
|
+
| -5017 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧页面内部初始化异常——重试,仍失败请反馈问题 |
|
|
690
|
+
| -5018 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 宿主页面内容未就绪——重试 |
|
|
691
|
+
| -5020 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 短剧运行时加载失败:当前基座缺少短剧原生类——必须使用云打包的自定义基座(manifest.json 配置 uni-ad 模块并含 gm-content 渠道) |
|
|
692
|
+
| -5500 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 广告 SDK 启动失败:uni-ad SDK 初始化 start 未成功(多为网络异常或模块未配置)——检查网络与 uni-ad 模块配置后重试 |
|
|
693
|
+
| errSubject | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 统一错误主题(模块)名称 |
|
|
694
|
+
| data | any | 否 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 错误信息中包含的数据 |
|
|
505
695
|
| cause | Error | 否 | | 源错误信息,可以包含多个错误,详见SourceError |
|
|
506
|
-
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) | |
|
|
696
|
+
| errMsg | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | |
|
|
507
697
|
|
|
508
698
|
#### onPlayEvent(callback : DramaEventCallback) : void @onplayevent
|
|
509
699
|
onPlayEvent
|
|
510
|
-
|
|
700
|
+
播放相关事件,事件数据包含 event(如 playStart / playEnd / pause / resume / seek / playComplete / nextPlaylet / playError / fullDisplay)与 info
|
|
511
701
|
##### onPlayEvent 兼容性
|
|
512
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
513
|
-
| :- | :- | :- |
|
|
514
|
-
| x | x | x |
|
|
702
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
703
|
+
| :- | :- | :- | :- | :- | :- |
|
|
704
|
+
| x | x | x | 5.32 | √ | x |
|
|
515
705
|
|
|
516
706
|
##### 参数
|
|
517
707
|
|
|
518
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
519
|
-
| :- | :- | :- | :-: |
|
|
520
|
-
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
708
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
709
|
+
| :- | :- | :- | :-: | :- |
|
|
710
|
+
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放/广告事件回调,res 为 DramaEventResult(event 事件名 + info 事件附加信息) |
|
|
521
711
|
|
|
522
712
|
##### DramaEventResult 的属性值 @dramaeventresult-values
|
|
523
713
|
|
|
524
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
525
|
-
| :- | :- | :- | :-: |
|
|
526
|
-
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
527
|
-
| info | UTSJSONObject | 是 | |
|
|
714
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
715
|
+
| :- | :- | :- | :-: | :- |
|
|
716
|
+
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 事件名:播放事件如 playStart / playEnd / pause / resume / seek / playComplete / nextPlaylet / playError / fullDisplay;<br/>广告事件如 show / click / close / skip / reward / loadSuccess / loadFail / videoPlayEnd / showError |
|
|
717
|
+
| info | UTSJSONObject | 是 | | 事件附加信息,字段随事件不同而不同(如 code / message / position / endTime / result),无附加信息时为空对象 |
|
|
528
718
|
|
|
529
719
|
#### offPlayEvent(callback : DramaEventCallback) : void @offplayevent
|
|
530
720
|
offPlayEvent
|
|
531
|
-
|
|
721
|
+
取消 onPlayEvent(callback) 注册的监听
|
|
532
722
|
##### offPlayEvent 兼容性
|
|
533
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
534
|
-
| :- | :- | :- |
|
|
535
|
-
| x | x | x |
|
|
723
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
724
|
+
| :- | :- | :- | :- | :- | :- |
|
|
725
|
+
| x | x | x | 5.32 | √ | x |
|
|
536
726
|
|
|
537
727
|
##### 参数
|
|
538
728
|
|
|
539
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
540
|
-
| :- | :- | :- | :-: |
|
|
541
|
-
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
729
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
730
|
+
| :- | :- | :- | :-: | :- |
|
|
731
|
+
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放/广告事件回调,res 为 DramaEventResult(event 事件名 + info 事件附加信息) |
|
|
542
732
|
|
|
543
733
|
##### DramaEventResult 的属性值 @dramaeventresult-values
|
|
544
734
|
|
|
545
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
546
|
-
| :- | :- | :- | :-: |
|
|
547
|
-
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
548
|
-
| info | UTSJSONObject | 是 | |
|
|
735
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
736
|
+
| :- | :- | :- | :-: | :- |
|
|
737
|
+
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 事件名:播放事件如 playStart / playEnd / pause / resume / seek / playComplete / nextPlaylet / playError / fullDisplay;<br/>广告事件如 show / click / close / skip / reward / loadSuccess / loadFail / videoPlayEnd / showError |
|
|
738
|
+
| info | UTSJSONObject | 是 | | 事件附加信息,字段随事件不同而不同(如 code / message / position / endTime / result),无附加信息时为空对象 |
|
|
549
739
|
|
|
550
740
|
#### onAdEvent(callback : DramaEventCallback) : void @onadevent
|
|
551
741
|
onAdEvent
|
|
552
|
-
|
|
742
|
+
短剧内广告相关事件,事件数据包含 event(如 show / click / close / skip / reward / loadSuccess / loadFail / videoPlayEnd / showError)与 info
|
|
553
743
|
##### onAdEvent 兼容性
|
|
554
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
555
|
-
| :- | :- | :- |
|
|
556
|
-
| x | x | x |
|
|
744
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
745
|
+
| :- | :- | :- | :- | :- | :- |
|
|
746
|
+
| x | x | x | 5.32 | √ | x |
|
|
557
747
|
|
|
558
748
|
##### 参数
|
|
559
749
|
|
|
560
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
561
|
-
| :- | :- | :- | :-: |
|
|
562
|
-
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
750
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
751
|
+
| :- | :- | :- | :-: | :- |
|
|
752
|
+
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放/广告事件回调,res 为 DramaEventResult(event 事件名 + info 事件附加信息) |
|
|
563
753
|
|
|
564
754
|
##### DramaEventResult 的属性值 @dramaeventresult-values
|
|
565
755
|
|
|
566
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
567
|
-
| :- | :- | :- | :-: |
|
|
568
|
-
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
569
|
-
| info | UTSJSONObject | 是 | |
|
|
756
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
757
|
+
| :- | :- | :- | :-: | :- |
|
|
758
|
+
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 事件名:播放事件如 playStart / playEnd / pause / resume / seek / playComplete / nextPlaylet / playError / fullDisplay;<br/>广告事件如 show / click / close / skip / reward / loadSuccess / loadFail / videoPlayEnd / showError |
|
|
759
|
+
| info | UTSJSONObject | 是 | | 事件附加信息,字段随事件不同而不同(如 code / message / position / endTime / result),无附加信息时为空对象 |
|
|
570
760
|
|
|
571
761
|
#### offAdEvent(callback : DramaEventCallback) : void @offadevent
|
|
572
762
|
offAdEvent
|
|
573
|
-
|
|
763
|
+
取消 onAdEvent(callback) 注册的监听
|
|
574
764
|
##### offAdEvent 兼容性
|
|
575
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
576
|
-
| :- | :- | :- |
|
|
577
|
-
| x | x | x |
|
|
765
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
766
|
+
| :- | :- | :- | :- | :- | :- |
|
|
767
|
+
| x | x | x | 5.32 | √ | x |
|
|
578
768
|
|
|
579
769
|
##### 参数
|
|
580
770
|
|
|
581
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
582
|
-
| :- | :- | :- | :-: |
|
|
583
|
-
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
771
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
772
|
+
| :- | :- | :- | :-: | :- |
|
|
773
|
+
| callback | (res: [DramaEventResult](#dramaeventresult-values)) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 播放/广告事件回调,res 为 DramaEventResult(event 事件名 + info 事件附加信息) |
|
|
584
774
|
|
|
585
775
|
##### DramaEventResult 的属性值 @dramaeventresult-values
|
|
586
776
|
|
|
587
|
-
| 名称 | 类型 | 必备 | 兼容性 |
|
|
588
|
-
| :- | :- | :- | :-: |
|
|
589
|
-
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
590
|
-
| info | UTSJSONObject | 是 | |
|
|
777
|
+
| 名称 | 类型 | 必备 | 兼容性 | 描述 |
|
|
778
|
+
| :- | :- | :- | :-: | :- |
|
|
779
|
+
| event | string | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 事件名:播放事件如 playStart / playEnd / pause / resume / seek / playComplete / nextPlaylet / playError / fullDisplay;<br/>广告事件如 show / click / close / skip / reward / loadSuccess / loadFail / videoPlayEnd / showError |
|
|
780
|
+
| info | UTSJSONObject | 是 | | 事件附加信息,字段随事件不同而不同(如 code / message / position / endTime / result),无附加信息时为空对象 |
|
|
591
781
|
|
|
592
782
|
#### onUnlockEvent(callback : DramaSimpleCallback) : void @onunlockevent
|
|
593
783
|
onUnlockEvent
|
|
594
|
-
|
|
784
|
+
短剧解锁相关事件(激励视频解锁成功等)
|
|
595
785
|
##### onUnlockEvent 兼容性
|
|
596
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
597
|
-
| :- | :- | :- |
|
|
598
|
-
| x | x | x |
|
|
786
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
787
|
+
| :- | :- | :- | :- | :- | :- |
|
|
788
|
+
| x | x | x | 5.32 | √ | x |
|
|
599
789
|
|
|
600
790
|
##### 参数
|
|
601
791
|
|
|
602
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
603
|
-
| :- | :- | :- | :-: |
|
|
604
|
-
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
792
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
793
|
+
| :- | :- | :- | :-: | :- |
|
|
794
|
+
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 简单事件回调,res 为事件数据对象(模块加载成功时含 providerType;播放页就绪时含 type / dramaId) |
|
|
605
795
|
|
|
606
796
|
#### offUnlockEvent(callback : DramaSimpleCallback) : void @offunlockevent
|
|
607
797
|
offUnlockEvent
|
|
608
|
-
|
|
798
|
+
取消 onUnlockEvent(callback) 注册的监听
|
|
609
799
|
##### offUnlockEvent 兼容性
|
|
610
|
-
| Web | 微信小程序 | 支付宝小程序 |
|
|
611
|
-
| :- | :- | :- |
|
|
612
|
-
| x | x | x |
|
|
800
|
+
| Web | 微信小程序 | 支付宝小程序 | Android | iOS | HarmonyOS |
|
|
801
|
+
| :- | :- | :- | :- | :- | :- |
|
|
802
|
+
| x | x | x | 5.32 | √ | x |
|
|
613
803
|
|
|
614
804
|
##### 参数
|
|
615
805
|
|
|
616
|
-
| 名称 | 类型 | 必填 | 兼容性 |
|
|
617
|
-
| :- | :- | :- | :-: |
|
|
618
|
-
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x(部分支持,见上) |
|
|
806
|
+
| 名称 | 类型 | 必填 | 兼容性 | 描述 |
|
|
807
|
+
| :- | :- | :- | :-: | :- |
|
|
808
|
+
| callback | (res: UTSJSONObject) => void | 是 | Web x / 微信小程序 x / 支付宝小程序 x / HarmonyOS x(部分支持,见上) | 简单事件回调,res 为事件数据对象(模块加载成功时含 providerType;播放页就绪时含 type / dramaId) |
|
|
619
809
|
|
|
620
810
|
## Tips
|
|
621
811
|
|