支付宝小程序API 网络状态

my.getNetworkType

简介

my.getNetworkType 是获取当前网络状态的 API。

扫码体验

示例代码

// API-DEMO page/API/get-network-type/get-network-type.json
{
    "defaultTitle": "获取手机网络状态"
}

<!-- API-DEMO page/API/get-network-type/get-network-type.axml-->
<view class="page">
  <view class="page-section">
    <view class="page-section-demo">
      <view class="page-body-title">网络状态</view>
      <block a:if="{{hasNetworkType === false}}">
        <text class="page-body-text">未获取</text>
        <text class="page-body-text">点击按钮可获取网络状态</text>
      </block>
      <block a:if="{{hasNetworkType === true}}">
        <text class="page-body-text-network-type">{{networkType}}</text>
      </block>
    </view>


    <view class="page-section-btns">
      <view onTap="getNetworkType">获取手机网络状态</view>
      <view onTap="clear">清空</view>
    </view>
  </view>
</view>

// API-DEMO page/API/get-network-type/get-network-type.js
Page({
  data: {
    hasNetworkType: false
  },
  onLoad() {
    this.onChange = this.onChange.bind(this);
    // my.onNetworkChange(this.onChange);
  },
  onChange(res){
    console.log('onNetworkChange', res);
    this.setData({
      hasNetworkType: true,
      networkType: res.networkType
    });
  },
  onUnload() {
    // my.offNetworkChange(this.onChange);
  },
  getNetworkType() {
    my.getNetworkType({
      success: (res) => {
        this.setData({
          hasNetworkType: true,
          networkType: res.networkType
        })
      }
    })
  },
  clear() {
    this.setData({
      hasNetworkType: false,
      networkType: ''
    })
  },
});

/* API-DEMO page/API/get-network-type/get-network-type.acss */
.page-body-info {
  height: 200rpx;
}
.page-body-text-network-type {
  font-size: 80rpx;
  font-family: Helvetica;
}

入参

Object 类型，属性如下：

属性	类型	必填	描述
success	Function	否	调用成功的回调函数。
fail	Function	否	调用失败的回调函数。
complete	Function	否	调用结束的回调函数（调用成功、失败都会执行）。

success 回调函数

入参为 Object 类型，属性如下：

属性	类型	描述
networkAvailable	Boolean	网络是否可用。
networkType	String	网络类型值 UNKNOWN / NOTREACHABLE / WIFI / 3G / 2G / 4G / WWAN。

my.offNetworkStatusChange

简介

my.offNetworkStatusChange 是取消监听网络状态变化的 API。

示例代码

// .js
my.offNetworkStatusChange();

是否需要传 callback 值

• 不传递 callback 值，则会移除监听所有的事件监听回调。示例代码如下：

my.offNetworkStatusChange();

• 传递 callback 值，只移除对应的 callback 事件。示例代码如下：

my.offNetworkStatusChange(this.callback);

my.onNetworkStatusChange

简介

my.onNetworkStatusChange 是开始监听网络状态变化的 API。

示例代码

// .js


my.onNetworkStatusChange(function(res){
    console.log(JSON.stringify(res))
})

返回值

属性	类型	描述
isConnected	Boolean	网络是否可用。
networkType	String	网络类型值：UNKNOWN / NOTREACHABLE / Wi-Fi / 3G / 2G / 4G / WWAN。