微信小程式常用API（總結分享）

本篇文章給大家帶來了關於的相關知識，其中主要總結了一些常用的API，下面一起來看一下，希望對大家有幫助。

zion無程式碼雲ide,帶你快速實現小程式開發立即使用

【相關學習推薦：】

一、系統常用api

1. wx.openAppAuthorizeSetting(Object object) 跳轉系統微信授權管理頁

引數
1）success  介面呼叫成功的回撥函數
2）fail  介面呼叫失敗的回撥函數
3）complete  介面呼叫結束的回撥函數（呼叫成功、失敗都會執行）
登入後複製

2. wx.getWindowInfo() 獲取視窗資訊

引數
1）pixelRatio	裝置畫素比
2）screenWidth	螢幕寬度，單位px
3）screenHeight	螢幕高度，單位px
4）windowWidth	可使用視窗寬度，單位px
5）windowHeight 可使用視窗高度，單位px
6）statusBarHeight	狀態列的高度，單位px
7）safeArea	在豎屏正方向下的安全區域
	left	安全區域左上角橫座標
	right	安全區域右下角橫座標
	top	安全區域左上角縱座標
	bottom	安全區域右下角縱座標
	width	安全區域的寬度，單位邏輯畫素
	height	安全區域的高度，單位邏輯畫素
8）screenTop	視窗上邊緣的 y 值.
登入後複製

3. wx.getSystemInfoAsync(Object object) 非同步獲取系統資訊。需要一定的微信使用者端版本支援，在不支援的使用者端上，會使用同步實現來返回。

引數
1）success  介面呼叫成功的回撥函數
2）fail  介面呼叫失敗的回撥函數
3）complete  介面呼叫結束的回撥函數（呼叫成功、	失敗都會執行）
登入後複製

4. wx.getAppAuthorizeSetting() 獲取微信 APP 授權設定

albumAuthorized	允許微信使用相簿的開關（僅 iOS 有效）
bluetoothAuthorized	允許微信使用藍芽的開關（僅 iOS 有效）
cameraAuthorized 允許微信使用攝像頭的開關
locationAuthorized	允許微信使用定位的開關
locationReducedAccuracy	定位準確度。true 表示模糊定位，false 表示精確定位（僅 iOS 有效）
microphoneAuthorized 允許微信使用麥克風的開關
notificationAuthorized 允許微信通知的開關
notificationAlertAuthorized	允許微信通知帶有提醒的開關（僅 iOS 有效）
notificationBadgeAuthorized	允許微信通知帶有標記的開關（僅 iOS 有效）
notificationSoundAuthorized	允許微信通知帶有聲音的開關（僅 iOS 有效）
phoneCalendarAuthorized	允許微信讀寫日曆的開關
登入後複製

二、小程式常用api

小程式常用生命週期

wx.getLaunchOptionsSync 獲取小程式啟動時的引數。與 App.onLaunch 的回撥引數一致。
wx.getEnterOptionsSync 獲取本次小程式啟動時的引數。如果當前是冷啟動，則返回值與 App.onLaunch 的回撥引數一致；如果當前是熱啟動，則返回值與 App.onShow 一致。
wx.onUnhandledRejection(function listener) 監聽未處理的 Promise 拒絕事件。該事件與 App.onUnhandledRejection 的回撥時機與引數一致。
wx.onThemeChange(function listener) 監聽系統主題改變事件。該事件與 App.onThemeChange 的回撥時機一致。
wx.onPageNotFound(function listener) 監聽小程式要開啟的頁面不存在事件。該事件與 App.onPageNotFound 的回撥時機一致。
wx.onLazyLoadError(function listener) 監聽小程式非同步元件載入失敗事件。
wx.onError(function listener) 監聽小程式錯誤事件。如指令碼錯誤或 API 呼叫報錯等。該事件與 App.onError 的回撥時機與引數一致。
wx.onAudioInterruptionEnd(function listener) 監聽音訊中斷結束事件。在收到 onAudioInterruptionBegin 事件之後，小程式內所有音訊會暫停，收到此事件之後才可再次播放成功
wx.onAppShow(function listener) 監聽小程式切前臺事件。該事件與 App.onShow 的回撥引數一致。
wx.onAppHide(function listener) 監聽小程式切後臺事件。該事件與 App.onHide 的回撥時機一致。

三、路由跳轉api

wx.switchTab(Object object) 跳轉到 tabBar 頁面，並關閉其他所有非 tabBar 頁面
wx.reLaunch(Object object) 關閉所有頁面，開啟到應用內的某個頁面
wx.redirectTo(Object object) 關閉當前頁面，跳轉到應用內的某個頁面。但是不允許跳轉到 tabbar 頁面。
wx.navigateTo(Object object) 保留當前頁面，跳轉到應用內的某個頁面。但是不能跳到 tabbar 頁面。使用 wx.navigateBack 可以返回到原頁面。小程式中頁面棧最多十層。
wx.navigateBack(Object object) 關閉當前頁面，返回上一頁面或多級頁面。可通過 getCurrentPages 獲取當前的頁面棧，決定需要返回幾層。
wx.exitMiniProgram(Object object) 退出當前小程式。必須有點選行為才能呼叫成功。

四、轉發api

wx.updateShareMenu(Object object) 更新轉發屬性
wx.showShareMenu(Object object) 顯示當前頁面的轉發按鈕
wx.showShareImageMenu(Object object) 開啟分享圖片彈窗，可以將圖片傳送給朋友、收藏或下載
wx.shareVideoMessage(Object object) 轉發視訊到聊天
wx.shareFileMessage(Object object) 轉發檔案到聊天

五、頁面互動

wx.showToast(Object object) 顯示訊息提示框
wx.showModal(Object object) 顯示模態對話方塊
wx.showLoading(Object object) 顯示 loading 提示框。需主動呼叫 wx.hideLoading 才能關閉提示框
wx.showActionSheet(Object object) 顯示操作選單
wx.hideToast(Object object) 隱藏訊息提示框
wx.hideLoading(Object object) 隱藏 loading 提示框
wx.enableAlertBeforeUnload(Object object) 開啟小程式頁面返回詢問對話方塊。
wx.disableAlertBeforeUnload(Object object) 關閉小程式頁面返回詢問對話方塊。