///
declare namespace WechatMiniprogram {
namespace WxAsync {
type CallbackOption = {
success?: (...args: any) => any;
fail?: (...args: any) => any;
complete?: (...args: any) => any;
};
type PromisifiedOption = Omit;
type PromisifiedResult = Promise>[0]>;
}
interface WxAsync {
// 基础:系统 - Base/System
openSystemBluetoothSettingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
openAppAuthorizeSettingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getSystemInfoAsyncAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getSystemInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getSkylineInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getRendererUserAgentAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 基础:更新 - Base/Update
updateWeChatAppAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 基础:调试 - Base/Debug
setEnableDebugAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 基础:分包加载 - Base/Subpackage
preDownloadSubpackageAsync(
option?: WxAsync.PromisifiedOption & {
onProgressUpdate?: LoadSubpackageTaskOnProgressUpdateCallback;
}
): WxAsync.PromisifiedResult;
// 基础:性能 - Base/Performance
preloadAssetsAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
preloadSkylineViewAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
preloadWebviewAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 路由 - Route
reLaunchAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
switchTabAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
redirectToAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
restartMiniProgramAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
navigateToAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
navigateBackAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 跳转 - Navigate
openEmbeddedMiniProgramAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
navigateToMiniProgramAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
navigateBackMiniProgramAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
exitMiniProgramAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 转发 - Share
updateShareMenuAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showShareMenuAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showShareImageMenuAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
shareVideoMessageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
shareFileMessageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideShareMenuAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getShareInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
authPrivateMessageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:交互 - UI/Interaction
showToastAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showModalAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showLoadingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showActionSheetAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideToastAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideLoadingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
enableAlertBeforeUnloadAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
disableAlertBeforeUnloadAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:导航栏 - UI/Navigation
showNavigationBarLoadingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setNavigationBarTitleAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setNavigationBarColorAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideNavigationBarLoadingAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideHomeButtonAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:背景 - UI/Background
setBackgroundTextStyleAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setBackgroundColorAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:TabBar - UI/TabBar
showTabBarRedDotAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
showTabBarAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setTabBarStyleAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setTabBarItemAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setTabBarBadgeAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
removeTabBarBadgeAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideTabBarRedDotAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
hideTabBarAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:字体 - UI/Font
loadFontFaceAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:下拉刷新 - UI/PullDown
startPullDownRefreshAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
stopPullDownRefreshAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:滚动 - UI/Scroll
pageScrollToAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:置顶 - UI/TopBar
/**
* @deprecated
*/
setTopBarTextAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 界面:窗口 - UI/Window
/**
* @deprecated
*/
setWindowSizeAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 网络:发起请求 - Network/Request
requestAsync(
option?: WxAsync.PromisifiedOption & {
onHeadersReceived?: OnHeadersReceivedCallback;
onChunkReceived?: OnChunkReceivedCallback;
}
): WxAsync.PromisifiedResult;
requestAsync(
option?: WxAsync.PromisifiedOption> & {
onHeadersReceived?: OnHeadersReceivedCallback;
onChunkReceived?: OnChunkReceivedCallback;
}
): Promise>;
// 网络:下载 - Network/Download
downloadFileAsync(
option?: WxAsync.PromisifiedOption & {
onHeadersReceived?: OnHeadersReceivedCallback;
onProgressUpdate?: DownloadTaskOnProgressUpdateCallback;
}
): WxAsync.PromisifiedResult;
// 网络:上传 - Network/Upload
uploadFileAsync(
option?: WxAsync.PromisifiedOption & {
onHeadersReceived?: OnHeadersReceivedCallback;
onProgressUpdate?: DownloadTaskOnProgressUpdateCallback;
}
): WxAsync.PromisifiedResult;
// 网络:WebSocket - Network/WebSocket
sendSocketMessageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
connectSocketAsync(
option?: WxAsync.PromisifiedOption & {
onClose?: OnSocketCloseCallback;
onError?: OnSocketErrorCallback;
onMessage?: OnSocketMessageCallback;
onOpen?: OnSocketOpenCallback;
}
): WxAsync.PromisifiedResult;
closeSocketAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 网络:mDNS - Network/mDNS
stopLocalServiceDiscoveryAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
startLocalServiceDiscoveryAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 支付 - Payment
requestVirtualPaymentAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
requestPluginPaymentAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
requestOrderPaymentAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
requestPaymentAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 数据缓存:存储 - Storage/Storage
setStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
removeStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getStorageInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getStorageAsync(option?: WxAsync.PromisifiedOption>): Promise>;
clearStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
batchSetStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
batchGetStorageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 数据缓存:周期性更新 - Storage/BackgroundFetch
setBackgroundFetchTokenAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getBackgroundFetchTokenAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getBackgroundFetchDataAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 数据分析 - DataAnalysis
getCommonConfigAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 画布 - Canvas
canvasToTempFilePathAsync(option?: WxAsync.PromisifiedOption, component?: Component.TrivialInstance | Page.TrivialInstance): Promise;
canvasPutImageDataAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
canvasGetImageDataAync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:图片 - Media/Image
saveImageToPhotosAlbumAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
previewMediaAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
previewImageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getImageInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
editImageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
cropImageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
compressImageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
chooseMessageFileAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
chooseImageAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:视频 - Media/Video
saveVideoToPhotosAlbumAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
openVideoEditorAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getVideoInfoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
compressVideoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
chooseVideoAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
chooseMediaAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:音频 - Media/Audio&Voice
/**
* @deprecated
*/
stopVoiceAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
playVoiceAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
pauseVoiceAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setInnerAudioOptionAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getAvailableAudioSourcesAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:背景音频 - Media/BackgroundAudio
/**
* @deprecated
*/
stopBackgroundAudioAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
seekBackgroundAudioAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
playBackgroundAudioAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
pauseBackgroundAudioAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
getBackgroundAudioPlayerStateAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:录音 - Media/Record
/**
* @deprecated
*/
stopRecordAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
/**
* @deprecated
*/
startRecordAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 媒体:实时语音 - Media/VoIP
updateVoIPChatMuteConfigAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
subscribeVoIPVideoMembersAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
setEnable1v1ChatAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
joinVoIPChatAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
join1v1ChatAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
exitVoIPChatAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
// 位置 - Location
stopLocationUpdateAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
startLocationUpdateBackgroundAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
startLocationUpdateAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
openLocationAsync(option?: WxAsync.PromisifiedOption): WxAsync.PromisifiedResult;
getLocationAsync(option?: WxAsync.PromisifiedOption