HarmonyOS API：@ohos.telephony.observer (observer)

版本：v3.1 Beta

@ohos.telephony.observer (observer)

更新时间: 2023-02-17 09:19

本模块提供订阅管理功能，可以订阅/取消订阅的事件包括：网络状态变化、信号状态变化、通话状态变化、蜂窝数据链路连接状态、蜂窝数据业务的上下行数据流状态、SIM状态变化。

说明

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import observer from '@ohos.telephony.observer'

observer.on('networkStateChange')

on(type: 'networkStateChange', callback: Callback<NetworkState>): void;

订阅网络状态变化事件，使用callback方式作为异步方法。

需要权限：ohos.permission.GET_NETWORK_INFO

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('networkStateChange', data =>{ 
    console.log("on networkStateChange, data:" + JSON.stringify(data));
});

observer.on('networkStateChange')

on(type: 'networkStateChange', options: { slotId: number }, callback: Callback<NetworkState>): void;

订阅指定卡槽位的网络状态变化事件，使用callback方式作为异步方法。

需要权限：ohos.permission.GET_NETWORK_INFO

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('networkStateChange', {slotId: 0}, data =>{ 
    console.log("on networkStateChange, data:" + JSON.stringify(data));
});

observer.off('networkStateChange')

off(type: 'networkStateChange', callback?: Callback<NetworkState>): void;

取消订阅网络状态变化事件，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = data => {
    console.log("on networkStateChange, data:" + JSON.stringify(data));
}
observer.on('networkStateChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('networkStateChange', callback);
observer.off('networkStateChange');

observer.on('signalInfoChange')

on(type: 'signalInfoChange', callback: Callback<Array<SignalInformation>>): void;

订阅信号状态变化事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('signalInfoChange', data =>{ 
    console.log("on signalInfoChange, data:" + JSON.stringify(data));
});

observer.on('signalInfoChange')

on(type: 'signalInfoChange', options: { slotId: number }, callback: Callback<Array<SignalInformation>>): void;

订阅指定卡槽位的信号状态变化事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('signalInfoChange', {slotId: 0}, data =>{ 
    console.log("on signalInfoChange, data:" + JSON.stringify(data));
});

observer.off('signalInfoChange')

off(type: 'signalInfoChange', callback?: Callback<Array<SignalInformation>>): void;

取消订阅信号状态变化事件，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = data => {
    console.log("on signalInfoChange, data:" + JSON.stringify(data));
}
observer.on('signalInfoChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('signalInfoChange', callback);
observer.off('signalInfoChange');

observer.on('callStateChange')

on(type: 'callStateChange', callback: Callback<{ state: CallState, number: string }>): void;

订阅通话状态变化事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('callStateChange', value =>{ 
    console.log("on callStateChange, state:" + value.state + ", number:" + value.number);
});

observer.on('callStateChange')

on(type: 'callStateChange', options: { slotId: number }, callback: Callback<{ state:CallState, number: string }>): void;

订阅通话状态变化事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('callStateChange', {slotId: 0}, value =>{ 
    console.log("on callStateChange, state:" + value.state + ", number:" + value.number);
});

observer.off('callStateChange')

off(type: 'callStateChange', callback?: Callback<{ state: CallState, number: string }>): void;

取消订阅通话状态变化事件，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = value => {
    console.log("on callStateChange, state:" + value.state + ", number:" + value.number);
}
observer.on('callStateChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('callStateChange', callback);
observer.off('callStateChange');

observer.on('cellularDataConnectionStateChange')⁷⁺

on(type: 'cellularDataConnectionStateChange', callback: Callback<{ state: DataConnectState, network: RatType}>): void;

订阅蜂窝数据链路连接状态，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('cellularDataConnectionStateChange', value =>{
    console.log("on cellularDataConnectionStateChange, state:" + value.state + ", network:" + value.network);
});

observer.on('cellularDataConnectionStateChange')⁷⁺

on(type: 'cellularDataConnectionStateChange', options: { slotId: number }, callback: Callback<{ state: DataConnectState, network: RatType }>): void;

订阅指定卡槽位的蜂窝数据链路连接状态，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('cellularDataConnectionStateChange', {slotId: 0}, value =>{
    console.log("on cellularDataConnectionStateChange, state:" + value.state + ", network:" + value.network);
});

observer.off('cellularDataConnectionStateChange')⁷⁺

off(type: 'cellularDataConnectionStateChange', callback?: Callback<{ state: DataConnectState, network: RatType}>): void;

移除订阅蜂窝数据链路连接状态，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = value => {
    console.log("on cellularDataConnectionStateChange, state:" + value.state + ", network:" + value.network);
}
observer.on('cellularDataConnectionStateChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('cellularDataConnectionStateChange', callback);
observer.off('cellularDataConnectionStateChange');

observer.on('cellularDataFlowChange')⁷⁺

on(type: 'cellularDataFlowChange', callback: Callback<DataFlowType>): void;

订阅蜂窝数据业务的上下行数据流状态，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('cellularDataFlowChange', data =>{
    console.log("on networkStateChange, data:" + JSON.stringify(data));
});

observer.on('cellularDataFlowChange')⁷⁺

on(type: 'cellularDataFlowChange', options: { slotId: number }, callback: Callback<DataFlowType>): void;

订阅指定卡槽位的蜂窝数据业务的上下行数据流状态，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('cellularDataFlowChange', {slotId: 0}, data =>{
    console.log("on cellularDataFlowChange, data:" + JSON.stringify(data));
});

observer.off('cellularDataFlowChange')⁷⁺

off(type: 'cellularDataFlowChange', callback?: Callback<DataFlowType>): void;

移除订阅蜂窝数据业务的上下行数据流状态，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = data => {
    console.log("on cellularDataFlowChange, data:" + JSON.stringify(data));
}
observer.on('cellularDataFlowChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('cellularDataFlowChange', callback);
observer.off('cellularDataFlowChange');

observer.on('simStateChange')⁷⁺

on(type: 'simStateChange', callback: Callback<SimStateData>): void;

订阅sim状态更改事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('simStateChange', data =>{
    console.log("on simStateChange, data:" + JSON.stringify(data));
});

observer.on('simStateChange')⁷⁺

on(type: 'simStateChange', options: { slotId: number }, callback: Callback<SimStateData>): void;

订阅指定卡槽位的sim状态更改事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

observer.on('simStateChange', {slotId: 0}, data =>{
    console.log("on simStateChange, data:" + JSON.stringify(data));
});

observer.off('simStateChange')⁷⁺

off(type: 'simStateChange', callback?: Callback<SimStateData>): void;

移除订阅sim状态更改事件，使用callback方式作为异步方法。

说明

可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Telephony.StateRegistry

参数：

示例：

let callback = data => {
    console.log("on simStateChange, data:" + JSON.stringify(data));
}
observer.on('simStateChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
observer.off('simStateChange', callback);
observer.off('simStateChange');

LockReason⁸⁺

SIM卡锁类型。

系统能力：以下各项对应的系统能力均为SystemCapability.Telephony.StateRegistry。

SimStateData⁷⁺

SIM卡类型和状态。

系统能力：以下各项对应的系统能力均为SystemCapability.Telephony.StateRegistry。

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-observer-0000001477981429-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001477981429__observeronnetworkstatechange​​