微信小程序學習(六)常用API

通過這幾天的學習,已經初步能夠了解小程序的目錄結構、程序配置、界面設置,以及對其api的簡單使用;

現在我們在繼續學習幾種在小程序中常用的api:

一、獲取系統信息:

1)wx.getSystemInfo(Object object):其參數爲回調函數,常用的有三種success(成功)、fail(失敗)、complete(完成);

對於success函數,其有一個默認參數res,可以獲取當前機型的數據信息,以解決小程序對不同機型的適配問題

screenWidth number 屏幕寬度,單位px
screenHeight number 屏幕高度,單位px
windowWidth number 可使用窗口寬度,單位px
windowHeight number 可使用窗口高度,單位px

一般我們就是用上述的幾個參數結合setData方法來實現小程序頁面的動態渲染; 

2)console.log():向調試面板中打印日誌。console 是一個全局對象,可以直接訪問。(類似於輸出函數,一般用於調試

3)微信小程序的交互api:

①wx.showToast(Object object) 用於顯示消息提示框,與wx.hideToast(Object object)連用;

屬性 類型 默認值 必填 說明
title string   提示的內容
icon string 'success' 圖標
image string   自定義圖標的本地路徑,image 的優先級高於 icon
duration number 1500 提示的延遲時間
mask boolean false 是否顯示透明蒙層,防止觸摸穿透
success function   接口調用成功的回調函數
fail function   接口調用失敗的回調函數
complete function   接口調用結束的回調函數(調用成功、失敗都會執行)

 注:對於上表中的屬性對於wx.hideToast(Object object)只有最後三種(三種回調函數)實際測試就散沒有其在延時之後

提示信息也會自己消失;

②wx.showModal(Object object):顯示模態對話框(類似於選項對話框true和false)

屬性 類型 默認值 必填 說明
title string   提示的標題
content string   提示的內容(提示內容信息,開發者定義)
showCancel boolean true 是否顯示取消按鈕
cancelText string '取消' 取消按鈕的文字,最多 4 個字符(一般不需要修改)
confirmText string '確定'

確認按鈕的文字,最多 4 個字符(一般不需要修改)

success function   接口調用成功的回調函數
fail function   接口調用失敗的回調函數
complete function   接口調用結束的回調函數(調用成功、失敗都會執行)

對於success回調函數其res屬性列表如下所示:

屬性 類型 說明
confirm boolean 爲 true 時,表示用戶點擊了確定按鈕
cancel boolean 爲 true 時,表示用戶點擊了取消(用於 Android 系統區分點擊蒙層關閉還是點擊取消按鈕關閉)

③wx.showLoading(Object object):顯示 loading 提示框。需主動調用 wx.hideLoading ()才能關閉提示;

屬性 類型 默認值 必填 說明
title string   提示的內容
mask boolean false 是否顯示透明蒙層,防止觸摸穿透
success function   接口調用成功的回調函數
fail function   接口調用失敗的回調函數
complete function   接口調用結束的回調函數(調用成功、失敗都會執行)

4)請求響應: 

①RequestTask wx.request(Object object)  發起 HTTPS 網絡請求;

屬性 類型 默認值 必填 說明
url string   開發者服務器接口地址(必填,請求服務器的url)
data string/object/ArrayBuffer   請求的參數(一般用於傳遞參數信息)
header Object   設置請求的 header,header 中不能設置 Referer。
content-type 默認爲 application/json
method string GET HTTP 請求方法(get和post)
dataType string json 返回的數據格式(一般使用默認不需要修改)
responseType string text 響應的數據類型
success function   接口調用成功的回調函數
fail function   接口調用失敗的回調函數
complete function   接口調用結束的回調函數(調用成功、失敗都會執行)

在success回調函數中,一般實現數據的動態渲染(res屬性表如下所示)、失敗回調函數中一般返回提示信息;

屬性 類型 說明
data string/Object/Arraybuffer 開發者服務器返回的數據(常用用於獲取數據)
statusCode number 開發者服務器返回的 HTTP 狀態碼
header Object

開發者服務器返回的 HTTP Response Header

DownloadTask wx.downloadFile(Object object):下載文件資源到本地。客戶端直接發起一個 HTTPS GET 請求,返回文件的本地臨時路徑,單次下載允許的最大文件爲 50MB。

屬性 類型 必填 說明
url string 下載資源的 url(服務器地址)
header Object HTTP 請求的 Header,Header 中不能設置 Referer
filePath string 指定文件下載後存儲的路徑(存儲的本地路徑)
success function 接口調用成功的回調函數
fail function 接口調用失敗的回調函數
complete function 接口調用結束的回調函數(調用成功、失敗都會執行)

object.success 回調函數其參數res的屬性列表如下所示:(一般不會使用,通過狀態碼判斷文件是否傳輸正確)

屬性 類型 說明
tempFilePath string 臨時文件路徑。沒傳入 filePath 指定文件存儲路徑時會返回,下載後的文件會存儲到一個臨時文件
filePath string 用戶文件路徑。傳入 filePath 時會返回,跟傳入的 filePath 一致
statusCode number 開發者服務器返回的 HTTP 狀態碼

UploadTask wx.uploadFile(Object object):將本地資源上傳到服務器。客戶端發起一個 HTTPS POST 請求,其中 content-type 爲 multipart/form-data

屬性 類型 必填 說明
url string 開發者服務器地址(上傳地址,一般開發者寫死在js中)
filePath string 要上傳文件資源的路徑(用戶本地文件路徑,即上傳的文件)
name string 文件對應的 key,開發者在服務端可以通過這個 key 獲取文件的二進制內容
header Object HTTP 請求 Header,Header 中不能設置 Referer
formData Object HTTP 請求中其他額外的 form data
success function 接口調用成功的回調函數
fail function 接口調用失敗的回調函數
complete function 接口調用結束的回調函數(調用成功、失敗都會執行)

object.success 回調函數的res屬性列表如下所示:(一般也不會主動調用,用戶不可見)

屬性 類型 說明
data string 開發者服務器返回的數據
statusCode number 開發者服務器返回的 HTTP 狀態碼

綜上所述對於有回調函數的api其都有三種類型的函數(成功、失敗、完成),對於成功的回調函數一般通過參數res來

獲取從服務器返回的數據信息並在該函數中使用setData方法對頁面進行動態渲染; 

(好多api呀,還得在看幾天,加油^_^,充實自己!!!)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章