微信小程序开发文档 第29页

wx.stopLocalServiceDiscovery(Object object) 基础库 2.4.0 开始支持，低版本需做兼容处理。 停止搜索 mDNS 服务 参数 Object object 属性 类型 默认值 必填 说明 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.fail 回调函数 参数 Object res 属性 类型 说明 errMsg string 错误信息 res.errMsg 的合法值 值 说明 最低版本 task not found 在当前没有处在搜索服务中的情况下调用 stopLocalServiceDiscovery wx.startLocalServiceDiscovery(Object object) 基础库 2.4.0 开始支持，低版本需做兼容处理。 开始搜索局域网下的 mDNS 服务。搜索的结果会通过 wx.onLocalService* 事件返回。 参数 Object object 属性 类型 默认值 必填 说明 serviceType string 是 要搜索的服务类型 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.fail 回调函数 参数 Object res 属性 类型 说明 errMsg string 错误信息 res.errMsg 的合法值 值 说明 最低版本 invalid param serviceType 为空 scan task already exist 在当前 startLocalServiceDiscovery 发起的搜索未停止的情况下，再次调用 startLocalServiceDiscovery 示例代码 wx.startLocalServiceDiscovery({ // 当前手机所连的局域网下有一个 _http._tcp. 类型的服务 serviceType: '_http._tcp.', success:...

wx.connectSocket(OBJECT) 创建一个 WebSocket 连接；一个微信小程序同时只能有一个 WebSocket 连接，如果当前已存在一个 WebSocket 连接，会自动关闭该连接，并重新创建一个 WebSocket 连接。 OBJECT参数说明： 参数 类型 必填 说明 最低版本 url String 是 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名   data Object 否 请求的数据   header Object 否 HTTP Header , header 中不能设置 Referer   method String 否 默认是GET，有效值： OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT   protocols StringArray 否 子协议数组 1.4.0 success Function 否 接口调用成功的回调函数   fail Function 否 接口调用失败的回调函数   complete Function 否 接口调用结束的回调函数（调用成功、失败都会执行）   示例代码： wx.connectSocket({ url: 'test.php', data:{ x: '', y: '' }, header:{ 'content-type': 'application/json' }, protocols: ['protocol1'], method:"GET" }) wx.onSocketOpen(CALLBACK) 监听WebSocket连接打开事件。 示例代码： wx.connectSocket({ url: 'test.php' }) wx.onSocketOpen(function(res) { console.log('WebSocket连接已打开！') }) wx.onSocketError(CALLBACK) 监听WebSocket错误。 示例代码： wx.connectSocket({ url: 'test.php' }) wx.onSocketOpen(function(res){ console.log('WebSocket连接已打开！') }) wx.onSocketError(function(res){ console.log('WebSocket连接打开失败，请检查！') }) wx.sendSocketMessage(OBJECT) 通过 WebSocket 连接发送数据，需要先 wx.connectSocket，并在 wx.onSocketOpen 回调之后才能发送。...

wx.uploadFile(OBJECT) 将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后，可通过此接口将本地资源上传到指定服务器。客户端发起一个HTTPS POST请求，其中Content-Type为multipart/form-data。 OBJECT参数说明： 参数 类型 必填 说明 url String 是 开发者服务器url filePath String 是 要上传文件资源的路径 name String 是 文件对应的key , 开发者在服务器端通过这个key可以获取到文件二进制内容 header Object 否 HTTP 请求 Header，header中不能设置Referer formData Object 否 HTTP 请求中其他额外的form data success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数（调用成功、失败都会执行） success返回参数说明： 参数 类型 说明 data String 开发者服务器返回的数据 statusCode Number HTTP状态码 示例代码： wx.chooseImage({ success:function(res){ var tempFilePaths = res.tempFilePaths wx.uploadFile({ url: 'http://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址 filePath: tempFilePaths[0], name:"file", formData:{ "user":"test" } success: function(res){ var data = res.data //do something } }) } }) 返回值： 基础库 1.4.0 开始支持，低版本需做兼容处理。 返回一个uploadTask对象，通过uploadTask，可监听上传进度变化事件，以及取消上传任务。 uploadTask 基础库 1.4.0 开始支持，低版本需做兼容处理。 一个可以监听上传进度变化事件，以及取消上传任务的对象 方法： UploadTask.abort() 基础库 1.4.0 开始支持，低版本需做兼容处理。 中断上传任务 UploadTask.offHeadersReceived(function callback) 基础库 2.1.0 开始支持，低版本需做兼容处理。 取消监听 HTTP Response Header 事件 参数 function callback HTTP Response Header 事件的回调函数...

RequestTask wx.request(Object object) 发起 HTTPS 网络请求。使用前请注意阅读相关说明。 参数 Object object 属性 类型 默认值 必填 说明 最低版本 url string 是 开发者服务器接口地址 data string/object/ArrayBuffer 否 请求的参数 header Object 否 设置请求的 header，header 中不能设置 Referer。 content-type 默认为 application/json timeout number 否 超时时间，单位为毫秒 2.10.0 method string GET 否 HTTP 请求方法 dataType string json 否 返回的数据格式 responseType string text 否 响应的数据类型 1.7.0 enableHttp2 boolean false 否 开启 http2 2.10.4 enableQuic boolean false 否 开启 quic 2.10.4 enableCache boolean false 否 开启 cache 2.10.4 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数（调用成功、失败都会执行） object.method 的合法值 值 说明 最低版本 OPTIONS HTTP 请求 OPTIONS GET HTTP 请求 GET HEAD HTTP 请求 HEAD POST HTTP 请求 POST PUT HTTP 请求 PUT DELETE HTTP 请求 DELETE TRACE HTTP 请求 TRACE CONNECT HTTP...

aria-component 无障碍访问 为了更好地满足视障人士对于小程序的访问需求，基础库自2.7.1起，支持部分ARIA标签。 无障碍特性在读屏模式下可以访问，iOS可通过设置->通用->辅助功能->旁白打开。 以 view 组件为例，开发者可以增加aria-role和aria-label属性。 其中aria-role表示组件的角色，当设置为’img’时，读屏模式下聚焦后系统会朗读出’图像’。设置为’button’时，聚焦后后系统朗读出’按钮’。 aria-label表示组件附带的额外信息，聚焦后系统会自动朗读出来。 小程序已经内置了一些无障碍的特性，对于非原生组件，开发者可以添加以下无障碍标签。 aria-hidden aria-role aria-label aria-checked aria-disabled aria-describedby aria-expanded aria-haspopup aria-selected aria-required aria-orientation aria-valuemin aria-valuemax aria-valuenow aria-readonly aria-multiselectable aria-controls tabindex aria-labelledby ria-orientation aia-multiselectable aria-labelledby 示例代码 <view aria-role="button" aria-label="提交表单">提交</view> 提示： 安卓和iOS读屏模式下设置aria-role后朗读的内容不同系统之间会有差异 可设置的aria-role可参看 Using Aria中的Widget Roles，部分role的设置在移动端可能无效。

基础库 2.9.0 开始支持，低版本需做兼容处理。 页面属性配置节点，用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。 通过这个节点可以获得类似于调用 wx.setBackgroundTextStyle wx.setBackgroundColor 等接口调用的效果。 属性 类型 默认值 必填 说明 最低版本 background-text-style string 否 下拉背景字体、loading 图的样式，仅支持 dark 和 light 2.9.0 background-color string 否 窗口的背景色，必须为十六进制颜色值 2.9.0 background-color-top string 否 顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持 2.9.0 background-color-bottom string 否 底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持 2.9.0 scroll-top string “” 否 滚动位置，可以使用 px 或者 rpx 为单位，在被设置时，页面会滚动到对应位置 2.9.0 scroll-duration number 300 否 滚动动画时长 2.9.0 page-style string “” 否 页面根节点样式，页面根节点是所有页面节点的祖先节点，相当于 HTML 中的 body 节点 2.9.0 body-font-size string “” 否 页面 page 的字体大小，可以设置为 system ，表示使用当前用户设置的微信字体大小 2.11.0 root-font-size string “” 否 页面的根字体大小，页面中的所有 rem 单位，将使用这个字体大小作为参考值，即 1rem 等于这个字体大小；自小程序版本 2.11.0 起，也可以设置为 system 2.9.0 bindresize eventhandle 否 页面尺寸变化时会触发 resize 事件， event.detail = { size: { windowWidth, windowHeight } } 2.9.0 bindscroll eventhandle 否 页面滚动时会触发 scroll 事件， event.detail = { scrollTop } 2.9.0 bindscrolldone eventhandle 否 如果通过改变 scroll-top 属性来使页面滚动，页面滚动结束后会触发 scrolldone 事件 2.9.0 示例代码 <page-meta background-text-style="{{bgTextStyle}}" background-color="{{bgColor}}" background-color-top="{{bgColorTop}}" background-color-bottom="{{bgColorBottom}}" scroll-top="{{scrollTop}}" page-style="color: green" root-font-size="16px" > <navigation-bar title="{{nbTitle}}"...

contact-button 客服会话按钮，用于在页面上显示一个客服会话按钮，用户点击该按钮后会进入客服会话。 属性名 类型 默认值 说明 size Number 18 会话按钮大小，有效值 18-27，单位：px type String default-dark 会话按钮的样式类型 session-from String   用户从该按钮进入会话时，开发者将收到带上本参数的事件推送。本参数可用于区分用户进入客服会话的来源。 type 有效值： 值 说明 default-dark   default-light   示例代码 <contact-button type="default-light" size="20" session-from="weapp" > </contact-button> 相关api：详见客服消息接口文档 相关组件：button 组件通过设置 open-type=”contact” 亦可进入客服会话

ad-custom 基础库 2.10.4 开始支持，低版本需做兼容处理。 原生模板 广告。 属性 类型 默认值 必填 说明 最低版本 unit-id string 是 广告单元id，可在小程序管理后台的流量主模块新建 2.10.4 ad-intervals number 否 广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 模板 广告不会自动刷新） 2.10.4 bindload eventhandle 否 广告加载成功的回调 2.10.4 binderror eventhandle 否 广告加载失败的回调，event.detail = {errCode: 1002} 2.10.4 错误码信息与解决方案表 错误码是通过binderror回调获取到的错误信息。 代码 异常情况 理由 解决方案 1000 后端错误调用失败 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1001 参数错误 使用方法错误 可以前往developers.weixin.qq.com确认具体教程（小程序和小游戏分别有各自的教程，可以在顶部选项中，“设计”一栏的右侧进行切换。 1002 广告单元无效 可能是拼写错误、或者误用了其他APP的广告ID 请重新前往mp.weixin.qq.com确认广告位ID。 1003 内部错误 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1004 无适合的广告 广告不是每一次都会出现，这次没有出现可能是由于该用户不适合浏览广告 属于正常情况，且开发者需要针对这种情况做形态上的兼容。 1005 广告组件审核中 你的广告正在被审核，无法展现广告 请前往mp.weixin.qq.com确认审核状态，且开发者需要针对这种情况做形态上的兼容。 1006 广告组件被驳回 你的广告审核失败，无法展现广告 请前往mp.weixin.qq.com确认审核状态，且开发者需要针对这种情况做形态上的兼容。 1007 广告组件被驳回 你的广告能力已经被封禁，封禁期间无法展现广告 请前往mp.weixin.qq.com确认小程序广告封禁状态。 1008 广告单元已关闭 该广告位的广告能力已经被关闭 请前往mp.weixin.qq.com重新打开对应广告位的展现。 Bug & Tip tip：在无广告展示时，ad-custom 标签不会占用高度 tip：ad-custom 组件不支持触发 bindtap 等触摸相关事件 tip：目前可以给 ad-custom 标签设置 wxss 样式调整广告宽度，以使广告与页面更融洽，但请遵循小程序流量主应用规范 tip：监听到error回调后，开发者可以针对性的处理，比如隐藏广告组件的父容器，以保证用户体验，但不要移除广告组件，否则将无法收到bindload的回调 tip：不同模板涉及一些不同的使用场景，具体方式请参考模板编辑器

official-account 基础库 2.3.0 开始支持，低版本需做兼容处理。 公众号关注组件。当用户扫小程序码打开小程序时，开发者可在小程序内配置公众号关注组件，方便用户快捷关注公众号，可嵌套在原生组件内。 Tips 使用组件前，需前往小程序后台，在“设置”->“关注公众号”中设置要展示的公众号。注：设置的公众号需与小程序主体一致。 在一个小程序的生命周期内，只有从以下场景进入小程序，才具有展示引导关注公众号组件的能力:当小程序从扫小程序码场景（场景值1047，场景值1124）打开时当小程序从聊天顶部场景（场景值1089）中的「最近使用」内打开时，若小程序之前未被销毁，则该组件保持上一次打开小程序时的状态当从其他小程序返回小程序（场景值1038）时，若小程序之前未被销毁，则该组件保持上一次打开小程序时的状态 为便于开发者调试，基础库 2.7.3 版本起开发版小程序增加以下场景展示公众号组件：开发版小程序从扫二维码（场景值 1011）打开 — 体验版小程序打开 组件限定最小宽度为300px，高度为定值84px。 每个页面只能配置一个该组件。 属性名 类型 说明 bindload EventHandle 组件加载成功时触发 binderror EventHandle 组件加载失败时触发 detail 对象 属性名 类型 说明 status Number 状态码 errMsg String 错误信息 status 有效值 值 说明 -2 网络错误 -1 数据解析错误 0 加载成功 1 小程序关注公众号功能被封禁 2 关联公众号被封禁 3 关联关系解除或未选中关联公众号 4 未开启关注公众号功能 5 场景值错误 6 重复创建 示例代码 <official-account></official-account>

ad 基础库 1.9.94 开始支持，低版本需做兼容处理。 Banner 广告。 属性 类型 默认值 必填 说明 最低版本 unit-id string 是 广告单元id，可在小程序管理后台的流量主模块新建 1.9.94 ad-intervals number 否 广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 Banner 广告不会自动刷新） 2.3.1 bindload eventhandle 否 广告加载成功的回调 2.2.1 binderror eventhandle 否 广告加载失败的回调，event.detail = {errCode: 1002} 2.2.1 bindclose eventhandle 否 广告关闭的回调 2.6.5 错误码信息与解决方案表 错误码是通过binderror回调获取到的错误信息。 代码 异常情况 理由 解决方案 1000 后端错误调用失败 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1001 参数错误 使用方法错误 可以前往developers.weixin.qq.com确认具体教程（小程序和小游戏分别有各自的教程，可以在顶部选项中，“设计”一栏的右侧进行切换。 1002 广告单元无效 可能是拼写错误、或者误用了其他APP的广告ID 请重新前往mp.weixin.qq.com确认广告位ID。 1003 内部错误 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1004 无适合的广告 广告不是每一次都会出现，这次没有出现可能是由于该用户不适合浏览广告 属于正常情况，且开发者需要针对这种情况做形态上的兼容。 1005 广告组件审核中 你的广告正在被审核，无法展现广告 请前往mp.weixin.qq.com确认审核状态，且开发者需要针对这种情况做形态上的兼容。 1006 广告组件被驳回 你的广告审核失败，无法展现广告 请前往mp.weixin.qq.com确认审核状态，且开发者需要针对这种情况做形态上的兼容。 1007 广告组件被驳回 你的广告能力已经被封禁，封禁期间无法展现广告 请前往mp.weixin.qq.com确认小程序广告封禁状态。 1008 广告单元已关闭 该广告位的广告能力已经被关闭 请前往mp.weixin.qq.com重新打开对应广告位的展现。 提示： 在无广告展示时，ad 标签不会占用高度 ad 组件不支持触发 bindtap 等触摸相关事件 目前可以给 ad 标签设置 wxss 样式调整广告宽度，以使广告与页面更融洽，但请遵循小程序流量主应用规范 监听到error回调后，开发者可以针对性的处理，比如隐藏广告组件的父容器，以保证用户体验，但不要移除广告组件，否则将无法收到bindload的回调。