Skip to content

API overview

CategoryMethodDescriptionasynchronous
Fallback ConfigurationinitFallback(config)Initialize non-end environment degradation configuration-
isFallbackMode()Check if in downgrade mode-
Environment and ConfigurationisInApp()Check if running within the app-
getEnv()Obtain runtime environment information (version, device, offline package, etc.)✓
setAPIEnvironment(env)Configure project environment (web fallback mode enabled; in-app reject)✓
getAPIEnvironment()Get the current project environment (native value passed through within the app)✓
getAppName()Get host app name✓
getAppIcon()Get host app icon (Base64)✓
getHostSettings(configName?)Get host app cloud control configuration✓
getHostSettingsByKey(key, configName?)Get host configuration by key✓
Host MethodscallHostMethod(name, params)Call host app custom method✓
reportEvent(name, params)Report tracking events✓
addEventCommonParam(key, value)Set common parameters for event tracking-
submitFeedback(params)Submit user feedback (viewable in the console under “Business Operations → User Feedback”)✓
openBrowser(url, title)Open browser page-
showToast(message)Display Toast notification-
setStatusBarDarkMode(isDark)Set status bar dark/light mode-
showKeyboard(selector)Invoke soft keyboard (Android empty implementation)-
Page NavigationopenPage(url, options)Open URL in a new page-
closePage()Close current page-
openExternal(url)Open URL via system (App Store, phone, etc.)-
openWithBrowser(url)Open URL in system browser-
Safe AreagetSafeArea()Get safe area (status bar/navigation bar height)-
Shareshare(content)Call system share-
requestShortUrl(url, baseUrl?)Generate short links from long links✓
requestShortUrlWithHtml(html, baseUrl?)Generate short links for HTML content (direct rendering)✓
LifecycleonForeground(callback)Listen to the foreground event-
onBackground(callback)Listen to the event of entering the background-
WebView Communicationpublish(key, data, targetId)Send messages to other WebViews-
subscribe(key, callback)Listen to broadcast messages-
Back ButtononBackPressed(callback)Listen for back button (interceptable)-
offBackPressed()Cancel back key listener-
File DownloaddownloadFile(options)Download file (supports progress callback)✓
downloadWithCache(fileUrl, fileMd5, cacheTts, fileCacheKey?)Download and cache the file; if the cache is hit, directly return the local path.✓
File OperationsfileExists(path)Check if the file exists✓
getFileMd5(path)Get file MD5✓
deleteFile(path)Delete file or directory✓
moveFile(src, dest)Move/Rename file✓
createDir(path)Create directory✓
listDir(path)List directory contents✓
readFile(path)Read text file✓
writeFile(path, content)Write to a text file✓
ZIPunzipFile(zipPath, destPath)Extract the ZIP file✓
zipDir(sourcePath, zipPath)Compress the directory into a ZIP file.✓
LogingetAuthProviders()Get the list of supported third-party login methods✓
requestLogin(options)Trigger third-party login✓
Payment
SuperSDK.pay.*
pay.purchase(payConfig)Initiate Purchase (Single Entry · Aggregate createOrder→pay · Return Three States)✓
pay.getProviders()Detect the list of payment methods supported by the host app✓
pay.registerProvider(name, provider)Register Provider (Web Checkout / Native IAP override)-
pay.restorePurchases(options)Client restore purchase (F036 PurchaseResult[] · provider optional implementation)✓
Push
SuperSDK.push.*
push.getStatus()Push status snapshot (supported / permission / registered / lastError / lastOpened)✓
push.requestPermission()Request notification permission (Android 13+ system dialog)✓
push.setTags(tags)Set device tags (null / [] = clear)✓
push.setUserId(userId)Set business user ID (null / '' = clear)✓
push.onMessage(callback)Listen for push notifications received in the foreground (push.message)-
push.onOpened(callback)Listen to push click events (push.opened)-
Experiment
SuperSDK.experiment.*
experiment.ready(options?)Wait for the first experiment result of this session (resolve even on timeout).✓
experiment.get(key, options?)Synchronously read experiment groups; the first read freezes the group, and exposure is reported by default.-
experiment.expose(key)Report exposure for experiments read with expose:false.-
experiment.getAll()For diagnostics: all results (not frozen, not exposed)-
experiment.refresh()Manual pull✓
experiment.setAttributes(map)Set custom audience attributes attr.* and re-fetch.-
AttributiongetAttribution(onlyFirst)Get attribution data✓
Native BlocknativeBlock.init()Initialization, scanning static <native-block>-
nativeBlock.create(options)Dynamically create native components✓
nativeBlock.destroy(blockId)Destroy the specified component-
nativeBlock.destroyAll()Destroy all components-
nativeBlock.updatePositions()Manually update component location-
Response CodegetSuEncCapabilities()Query the suenc codec supported by this client-
decodeSuEnc(encodedData, codec)Decode the suenc response body-