小程序开发常用API

wx.canIUse(string schema)

判断小程序的API、回调、参数、组件等是否在当前版本可用

wx.getSystemInfoSync() | wx.getSystemInfo()

获取系统信息

wx.getLaunchOptionsSync()

获取小程序启动时的参数

属性

path:启动小程序的路径

scene:启动小程序的场景值

query:启动小程序的query参数

shareTicket:转发信息

referrerInfo:来源信息

应用级事件

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

监听小程序要打开的页面不存在事件

属性

path:不存在页面的路径

query:不存在也秒的query参数

isEntryPage:时候本次启动的首个页面

wx.onError(function callback)

监听小程序错误事件

wx.onAudioInterruptionEnd(function callback)

监听音视频中断结束事件

wx.onAudioInterruptionBegin(function callback)

监听音频因系统占用而被中断开始事件(闹钟、电话、语音聊天、视频聊天等)

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

监听小程序切前台事件

属性

path:小程序切前台的路径

scene: 小程序切前台的场景值

query:小程序切前台的query参数

ShareTicket:转发信息

referrerInfo:来源信息

wx.onAppHide | App.onHide

监听小程序切后台事件

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

取消监听事件

定时器

clearInterval(interavalID)

取消setInterval设置的定时器

clearTimeout(timeoutID)

取消setTimeout 设置的定时器

setInterval(callback,number delay, any rest)

设置Interval定时器

setTimeout(callback,number delay, any rest)

设置timeout定时器

路由

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

页面路由

参数:

url: 需要跳转的页面路径

success:调用成功的回调函数

fail:调用失败的回调函数

complete: 调用结束的回调函数

界面相关

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

显示消息框

参数

title: 提示的内容

icon: 图标

image: 自定义图标的本地路径,优先级高于icon

duration: 提示的延迟时间

mask: 是否显示透明蒙层

success: 调用成功的回调函数

fail: 调用失败的回调函数

complete: 接口调用结束的回调函数

wx.showModal(object)

显示模态对话框

参数:

title: 提示的标题

content: 提示的内容

showCancel: 是否显示取消按钮

cancelText: 取消按钮文字

cancelColor: 取消按钮文字颜色

confirmTextL 确认按钮的文字

confirmColor: 确认按钮的文字颜色

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

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

显示loading提示框

参数

title: 提示的内容

mask: 是否显示透明蒙层

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

wx.pageScrollTo(Object)

将页面滚动到目标位置

参数

scrollTop: 滚动到页面的目标位置

duration: 滚动动画的时长

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

网络相关

wx,request(object)

发起网络请求

参数

url: 服务器接口地址

data: 请求参数

header: 设置请求的header

method:HTTP请求方法

dataType: 返回的数据格式

responseType:响应的数据类型

success: 接口调用成功的回调函数

fail:接口调用失败的回调函数

complete: 接口调用结束的回调函数

wx.downloadFile(object)

下载文件资源到本地

参数

url:下载资源的url

header:HTTP请求的Header

filePath: 指定文件下载后存储的路径

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete:接口调用结束的回调函数

wx.uploadFile(object)

将本地资源上传到服务器

参数

url: 开发者服务器地址

filePath: 要上传文件资源的路径

name: 文件对应的key

header: HTTP请求的Header

formData: HTTP请求中其他额外的form data

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

wx.connectSocket(object)

创建一个WebSocket连接

属性

url: 服务器wss接口地址

header: HTTP Header

protocols: 子协议数组

tcpNoDelay: 建立TCP 连接的时候的TCP_NODELAY设置

success: 接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

wx.closeSocket(object)

关闭WebSocket 连接

参数

code: 连接状态号

reason:表示连接被关闭的原因

success:接口调用成功的回调函数

fail: 接口调用失败的回调函数

complete: 接口调用结束的回调函数

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

监听webSocket 相关事件

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342