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

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

【相關學習推薦：小程式學習教學】

## 一、系統常用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) Close the mini program page and return to the query dialog box.

[Related learning recommendations: 小program learning tutorial]

以上是微信小程式常用API（總結分享）的詳細內容。更多資訊請關注PHP中文網其他相關文章！