微信小程序 API 基础

时间:2022-06-23 03:58:09

  其实还有一些组件,没有提,因为那些组件跟 API 的功能差不多,API 可能比他会更好一点; 

  具体可见官方文档 

  基础:

    判断接口是否可用:wx.canIUse(a)  

      a 代表:接口名字  返回值:布尔  true代表成功,false代表接口不可用

    系统信息:wx.getSystemInfo({})  使用第二种

      参数:{}  success:代表成功

             fail:代表失败

             complete:接口调用完成后的回调函数

      案例:

        wx.getSystemInfo({

          success(res) {

            console.log(res)    //res  便是获取信息的参数的对象

          }

        })

    系统更新的API:wx.getUpdateManager()  //他的返回值,拥有很多的方法

      案例:

        const sd=wx.getUpdateManager()  //在 sd 上拥有 有关系统更细的方法  const 表示初始值不能被修改

        sd.applyUpdate()  强制小程序并使用新版本,在小程序下载完成后调用(必须在使用  onUpdateReady 回调这方法才有效); 直接调用即可

        sd.onCheckForUpdate()  监听向微信后台请求检查更新结果的事件,微信小程序冷启动的自动检查更新,不需由开发者主动触发;参数 :回调函数

        sd.onUpdateReady()  监听小程序有版本更新事件,客户端主动触发下载(无需开发者主动触发),下载成功后回调;参数:回调函数

        sd.onUpdateFailed()  监听小程序更新失败的事件,客户端主动触发下载(无需开发者主动触发),下载失败后回调(可能由于网络原因);参数:回调函数

     用法:

        const sd=wx.getUpdateManager()

        sd.onCheckForUpdate(function(e){

          console.log(e)

        }) 

    生命周期 API:wx.getLaunchOptionsSync()  获取小程序启动时的参数,  他的参数在他的实例对象上

    应用级事件:

      wx.onPageNotFoound()  监听小程序打开页面不存在的事件,该事件与 App.onPageNotFound 的回调时机一致; 参数:回调函数

      wx.onError()  监听小程序的错误事件,比如脚本错误,或 API 调用报错等等,该事件与 App.onError的回调时机与参数一致;参数:回调函数

      wx.onAudioInterruptionBegin()  监听音频受系统占用而被中断的开始事件,在以下场景触发:闹钟,电话,FaceTime,通话,微信语音聊天,微信视频聊天,小程序音频会暂停;参数:回调函数

      wx.onAudioInterruptionEnd()  监听音频中断结束事件(在收到 onAudioInterruptionBegin 事件之后,小程序内的所有音频会暂停),收到此事件之后可再次播放成功;参数:回调函数

      wx.onAppShow()  监听小程序切前台事件,该事件与 App.onshow()的回调参数一致;参数:回调函数

      wx.onAppHide()  监听小程序切后台事件,该事件与 App.onHide() 的回调时机一致;参数:回调函数

      wx.offPageNotFound()  取消监听小程序要打开的页面不存在事件;参数:回调函数

      wx.offError()  取消监听小程序错误事件

      wx.offAudioInterruptionBegin()  取消监听音频,因受系统占用而被中断的开始事件;参数:回调函数

      wx.offAudioInterruptionEnd()  取消监听音频中断结束事件;参数:回调函数

      wx.offAppShow()  取消监听小程序前台事件;参数:回调函数

      wx.offAppHide()  取消监听小程序后台事件;参数:回调函数

    调试:

      wx.setEnableDebug()  设置是否打开调试开关,此开关对正式版也能生效  参数:对象

        属性:enableDebug:类型  布尔  是否打开调试

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

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

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

        案例:

          wx.setEnableDebug({

            ecableDebug:true,

            success:function(e){

              console.log(e)

            }

          })

    案例:

      var sd=wx.getLogManager()  获取日志管理器对象  参数:实例对象(sd) 随便写  

      实例对象:日志管理器的实例

        sd.debug()  写 debug 日志

        sd.info()  写 info 日志

        sd.log()  写 log 日志

        sd.warn()  写 warn 日志

      console:向调试面板中打印日志 ,console是一个全局对象,可以直接访问,在微信客户端中,向vConsole 中,输入日志

      console的方法:

        console.debug()  向调试面板中打印 debug 日志

        console.log()  向调试面板中打印 log 日志

        console.info()  向调试面板中打印 info 日志

        console.warn()  向调试面板中 warn 日志

        console.error()  向调试面板中 error 日志

        console.group()  在调试面板中创建一个新的分组,随后输出的内容都会被添加一个缩进,表示该内容属于当前分组,在调用 console.groupEnd 之后分组结束

        console.groupEnd()  结束由 console.group 创建的分组

    定时器:

      setInterval():设定一个定时器。按照指定的周期(以毫秒计)来执行注册的回调函数

        参数一:回调函数

        参数二:执行回调函数的时间间隔  (以毫秒为单位)

        参数三:将参数传给回调函数

      setTimeout():设定一个定时器,在一段时间后回调函数

        参数一:回调函数

        参数二:多少时间后,执行回调函数  (以毫秒为单位)

        参数三:将参数传给回调函数

      clearInterval():取消由 setInterval 设置的定时器

      clearTimeout():取消由 setTimeout 设置的定时器