Network Status

API Declaration

Add the following configuration to the features attribute in the manifest.json file:

{"name": "system.network"}

Module Import

Add the following configuration to the script element on the page where the API will be called:

import network from '@system.network'

Or

var network = require("@system.network")

Application Scope

Definition

[h2]network.getType(OBJECT)

Description

Obtains the network type.

OBJECT

Parameters returned by success

Sample code

network.getType({
    success:function(data){console.log("handling success: " + data.type);}
})

[h2]network.subscribe(OBJECT)

Description

Listens to the network connection status. If this API is called multiple times, only the last call takes effect.

OBJECT

Returns

Sample code

network.subscribe({
    callback:function(data){console.log("handling callback");}
})

[h2]network.unsubscribe()

Description

Cancels listening to the network connection status.

Sample code

network.unsubscribe()

[h2]network.getSimOperators(OBJECT) (1070+)

Description

Obtains the carrier information of a SIM card. The call permission is required.

OBJECT

Parameters returned by success

Result codes returned by fail

SIM card list parameters

Sample code

network.getSimOperators({
    success:function (data) {
        console.log(`size: ${data.size}`)
        for (const i in data.operators) {
            console.log(`operator: ${data.operators[i].operator},
                    slotIndex:${data.operators[i].slotIndex},
                    isDefaultDataOperator:${data.operators[i].isDefaultDataOperator},`
            )
        }
    },
    fail:function (erromsg, errocode) {
        console.log('errocode: ' + errocode + ' – erromsg: ' + erromsg)
    }
})

[h2]network.getNetworkOperator(OBJECT) (1078+)

Description

Obtains the carrier of the network connected by a SIM card.

Parameters

Parameters returned by success

Parameters returned by fail

Sample code

network.getNetworkOperator({
    success:function (data) {
        console.log(`size: ${data.size}`)
        for (const i in data.operators) {
            console.log(`operator: ${data.operators[i].operator},
                    slotIndex:${data.operators[i].slotIndex},
                    isDefaultDataOperator:${data.operators[i].isDefaultDataOperator},`
            )
        }
    },
    fail:function (erromsg, errocode) {
        console.log('errocode: ' + errocode + ' – erromsg: ' + erromsg)
    }
})

Demo

<template>
  <div class="container">

    <div class="item-container">
      <div class="item-content">
        <text class="txt">networkType: {{networkType}}</text>
      </div>
      <input type="button" class="btn" onclick="getNetworkType"  value="Get Network Type" />

      <div class="item-content">
        <text class="txt">currentType: {{currentType}}</text>
      </div>
      <input type="button" class="btn" onclick="listenNetwork"  value="listen Network" />
      <input type="button" class="btn" onclick="cancelNetwork"  value="cancel Network" />
      <div class="item-content">
        <text class="txt">carrierInformation:{{simOperatorsInfo}}</text>
      </div>
      <input type="button" class="btn" onclick="getSimOperators"  value="Get Carrier Information" />
    </div>
  </div>
</template>

<style>
.container{
  flex: 1;
  flex-direction: column;
}
  .item-container {
    margin-bottom: 50px;
    margin-right: 60px;
    margin-left: 60px;
    flex-direction: column;
  }

  .item-content {
    flex-direction: column;
    padding: 30px;
    margin-bottom: 100px;
    align-items: flex-start;
  }
  .btn {
  height: 80px;
  text-align: center;
  border-radius: 5px;
  margin-right: 60px;
  margin-left: 60px;
  margin-bottom: 50px;
  color: #ffffff;
  font-size: 30px;
  background-color: #0faeff;
}
</style>

<script>
  import network from '@system.network'
  import prompt from '@system.prompt'

  export default {
    data: {
      networkType: '',
      currentType: '',
      simOperatorsInfo: '',
    },
    onInit: function () {
      this.$page.setTitleBar({ text: 'network' })
    },
    getNetworkType: function () {
      var that = this
      network.getType({
        success: function (ret) {
          that.networkType = JSON.stringify(ret);

        },
        fail: function (erromsg, errocode) {
          console.log('network.getType----------' + errocode + ': ' + erromsg)
        },
        complete: function () {
          prompt.showToast({
            message: "get network type complete!"
          })
        }
      })
    },
    listenNetwork: function () {
      var that = this
      network.subscribe({
        callback: function (ret) {
          that.currentType = JSON.stringify(ret)
          prompt.showToast({ message:"listenSuccess" + JSON.stringify(ret) })
        },
        fail: function (erromsg, errocode) {
          prompt.showToast({ message: "listenFailed" + errocode + ': ' + erromsg })
          console.log('network.subscribe----------' + errocode + ': ' + erromsg)
        }
      })
    },
    cancelNetwork: function () {
      network.unsubscribe()
    },
    getSimOperators: function () {
      var that = this
      var simOperatorsInfo = ''
      network.getSimOperators({
        success: function (data) {
          console.log(`size: ${data.size}`)
          for (const i in data.operators) {
            simOperatorsInfo += `operator: ${data.operators[i].operator},\tslotIndex:${data.operators[i].slotIndex},\tisDefaultDataOperator:${data.operators[i].isDefaultDataOperator},\n`
          }
          that.simOperatorsInfo = JSON.stringify(data)
          console.log(simOperatorsInfo)
        },
        fail: function (erromsg, errocode) {
          console.log('errocode: ' + errocode + ' - erromsg: ' + erromsg)
        }
      })
    }
  }
</script>

The following figure shows the final effect.

Version Change History

Links

[h2]FAQs

What can I do when there is no response to a success callback when the network.subscribe(OBJECT) API is called?

[h2]Cases

• Listening to Network Status Changes Globally
• Playing or Pausing a Video Based on the Network Status