小程序開發(fā)常用API

wx.canIUse(string schema)

判斷小程序的API、回調(diào)、參數(shù)、組件等是否在當(dāng)前版本可用

wx.getSystemInfoSync()?|?wx.getSystemInfo()

獲取系統(tǒng)信息

wx.getLaunchOptionsSync()

獲取小程序啟動(dòng)時(shí)的參數(shù)

屬性

path:?jiǎn)?dòng)小程序的路徑

scene:?jiǎn)?dòng)小程序的場(chǎng)景值

query:?jiǎn)?dòng)小程序的query參數(shù)

shareTicket:轉(zhuǎn)發(fā)信息

referrerInfo:來(lái)源信息

應(yīng)用級(jí)事件

wx.onPageNotFound(function callback)?|?App.onPageNotFound(function callback)

監(jiān)聽小程序要打開的頁(yè)面不存在事件

屬性

path:不存在頁(yè)面的路徑

query:不存在也秒的query參數(shù)

isEntryPage:時(shí)候本次啟動(dòng)的首個(gè)頁(yè)面

wx.onError(function callback)

監(jiān)聽小程序錯(cuò)誤事件

wx.onAudioInterruptionEnd(function callback)

監(jiān)聽音視頻中斷結(jié)束事件

wx.onAudioInterruptionBegin(function callback)

監(jiān)聽音頻因系統(tǒng)占用而被中斷開始事件(鬧鐘、電話、語(yǔ)音聊天、視頻聊天等)

wx.onAppShow(function callback)?|?App.onShow(function callback)

監(jiān)聽小程序切前臺(tái)事件

屬性

path:小程序切前臺(tái)的路徑

scene: 小程序切前臺(tái)的場(chǎng)景值

query:小程序切前臺(tái)的query參數(shù)

ShareTicket:轉(zhuǎn)發(fā)信息

referrerInfo:來(lái)源信息

wx.onAppHide?|?App.onHide

監(jiān)聽小程序切后臺(tái)事件

wx.offPageNotFound(function callback)?|?wx.offError(function callback)?|?wx.offAudioInterruptionEnd(function callBack)?|?wx.offAudioInterruptionBegin(function callBack)?|?wx.offAppShow(function callBack)?|?wx.offAppHide(function callBack)

取消監(jiān)聽事件

定時(shí)器

clearInterval(interavalID)

取消setInterval設(shè)置的定時(shí)器

clearTimeout(timeoutID)

取消setTimeout 設(shè)置的定時(shí)器

setInterval(callback,number delay, any rest)

設(shè)置Interval定時(shí)器

setTimeout(callback,number delay, any rest)

設(shè)置timeout定時(shí)器

路由

wx.switchTab(object)?I?wx.reLaunch(object)?|?wx…redirect(object)?|?wx.navigateTo(object)?|?wx.navigateBack(object)

頁(yè)面路由

參數(shù):

url: 需要跳轉(zhuǎn)的頁(yè)面路徑

success:調(diào)用成功的回調(diào)函數(shù)

fail:調(diào)用失敗的回調(diào)函數(shù)

complete: 調(diào)用結(jié)束的回調(diào)函數(shù)

界面相關(guān)

wx.showToast(object)?|?wx.hideToast(object)

顯示消息框

參數(shù)

title: 提示的內(nèi)容

icon: 圖標(biāo)

image: 自定義圖標(biāo)的本地路徑,優(yōu)先級(jí)高于icon

duration: 提示的延遲時(shí)間

mask: 是否顯示透明蒙層

success: 調(diào)用成功的回調(diào)函數(shù)

fail: 調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.showModal(object)

顯示模態(tài)對(duì)話框

參數(shù):

title: 提示的標(biāo)題

content: 提示的內(nèi)容

showCancel: 是否顯示取消按鈕

cancelText: 取消按鈕文字

cancelColor: 取消按鈕文字顏色

confirmTextL 確認(rèn)按鈕的文字

confirmColor: 確認(rèn)按鈕的文字顏色

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.showLoading(object)?|?wx.hideLoading(object)

顯示loading提示框

參數(shù)

title: 提示的內(nèi)容

mask: 是否顯示透明蒙層

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.pageScrollTo(Object)

將頁(yè)面滾動(dòng)到目標(biāo)位置

參數(shù)

scrollTop: 滾動(dòng)到頁(yè)面的目標(biāo)位置

duration: 滾動(dòng)動(dòng)畫的時(shí)長(zhǎng)

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

網(wǎng)絡(luò)相關(guān)

wx,request(object)

發(fā)起網(wǎng)絡(luò)請(qǐng)求

參數(shù)

url: 服務(wù)器接口地址

data: 請(qǐng)求參數(shù)

header: 設(shè)置請(qǐng)求的header

method:HTTP請(qǐng)求方法

dataType: 返回的數(shù)據(jù)格式

responseType:響應(yīng)的數(shù)據(jù)類型

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail:接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.downloadFile(object)

下載文件資源到本地

參數(shù)

url:下載資源的url

header:HTTP請(qǐng)求的Header

filePath: 指定文件下載后存儲(chǔ)的路徑

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete:接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.uploadFile(object)

將本地資源上傳到服務(wù)器

參數(shù)

url: 開發(fā)者服務(wù)器地址

filePath: 要上傳文件資源的路徑

name: 文件對(duì)應(yīng)的key

header: HTTP請(qǐng)求的Header

formData: HTTP請(qǐng)求中其他額外的form data

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.connectSocket(object)

創(chuàng)建一個(gè)WebSocket連接

屬性

url: 服務(wù)器wss接口地址

header: HTTP Header

protocols: 子協(xié)議數(shù)組

tcpNoDelay: 建立TCP 連接的時(shí)候的TCP_NODELAY設(shè)置

success: 接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.closeSocket(object)

關(guān)閉WebSocket 連接

參數(shù)

code: 連接狀態(tài)號(hào)

reason:表示連接被關(guān)閉的原因

success:接口調(diào)用成功的回調(diào)函數(shù)

fail: 接口調(diào)用失敗的回調(diào)函數(shù)

complete: 接口調(diào)用結(jié)束的回調(diào)函數(shù)

wx.onSocketMessage(function)?|?wx.onSocketError(object)?|?wx.onSocketClose(object)?|?wx.onSocketOpen(object)

監(jiān)聽webSocket 相關(guān)事件

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容