diff --git a/zh-cn/application-dev/reference/apis/js-apis-observer.md b/zh-cn/application-dev/reference/apis/js-apis-observer.md index e020047aa5e967808761fede6d7c06e4e407b2d8..46cb6213e1cd3042210684b78f1f5c9d9d20ebee 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-observer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-observer.md @@ -263,3 +263,279 @@ observer.on('callStateChange', callback); observer.off('callStateChange', callback); observer.off('callStateChange'); ``` + + +## observer.on('cellularDataConnectionStateChange')7+ + +on\(type: 'cellularDataConnectionStateChange', callback: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void; + +订阅蜂窝数据链路连接状态,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据链路连接状态事件 | +| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 是 | 回调函数,参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState),radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 | + +**示例:** + +``` +observer.on('cellularDataConnectionStateChange', value =>{ + console.log("on cellularDataConnectionStateChange, state:" + value.state + ", network:" + value.network); +}); +``` + + +## observer.on('cellularDataConnectionStateChange')7+ + +on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, callback: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void; + +订阅指定卡槽位的蜂窝数据链路连接状态,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据链路连接状态事件 | +| slotId | number | 是 | 卡槽ID。
- 0:卡槽1
- 1:卡槽2 | +| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 是 | 回调函数,参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState),radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 | + +**示例:** + +``` +observer.on('cellularDataConnectionStateChange', {slotId: 0}, value =>{ + console.log("on cellularDataConnectionStateChange, state:" + value.state + ", network:" + value.network); +}); +``` + + +## observer.off('cellularDataConnectionStateChange')7+ + +off\(type: 'cellularDataConnectionStateChange', callback?: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void; + +移除订阅蜂窝数据链路连接状态,使用callback方式作为异步方法。 + +>**说明:** +> +>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据链路连接状态事件 | +| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 否 | 回调函数,参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState),radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 | + +**示例:** + +``` +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')7+ + +on\(type: 'cellularDataFlowChange', callback: Callback\\): void; + +订阅蜂窝数据业务的上下行数据流状态,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据业务的上下行数据流状态状态事件 | +| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 是 | 回调函数,参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 | + +**示例:** + +``` +observer.on('cellularDataFlowChange', data =>{ + console.log("on networkStateChange, data:" + JSON.stringify(data)); +}); +``` + + +## observer.on('cellularDataFlowChange')7+ + +on\(type: 'cellularDataFlowChange', options: { slotId: number }, callback: Callback\\): void; + +订阅指定卡槽位的蜂窝数据业务的上下行数据流状态,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 | +| slotId | number | 是 | 卡槽ID。
- 0:卡槽1
- 1:卡槽2 | +| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 是 | 回调函数,参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 | + +**示例:** + +``` +observer.on('cellularDataFlowChange', {slotId: 0}, data =>{ + console.log("on cellularDataFlowChange, data:" + JSON.stringify(data)); +}); +``` + + +## observer.off('cellularDataFlowChange')7+ + +off\(type: 'cellularDataFlowChange', callback?: Callback\\): void; + +移除订阅蜂窝数据业务的上下行数据流状态,使用callback方式作为异步方法。 + +>**说明:** +> +>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 | +| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 否 | 回调函数,参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 | + +**示例:** + +``` +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')7+ + +on\(type: 'simStateChange', callback: Callback\\): void; + +订阅sim状态更改事件,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | sim状态更改事件 | +| callback | Callback\<[SimStateData](#simstatedata7)\> | 是 | 回调函数。 | + +**示例:** + +``` +observer.on('simStateChange', data =>{ + console.log("on simStateChange, data:" + JSON.stringify(data)); +}); +``` + + +## observer.on('simStateChange')7+ + +on\(type: 'simStateChange', options: { slotId: number }, callback: Callback\\): void; + +订阅指定卡槽位的sim状态更改事件,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | sim状态更改事件 | +| slotId | number | 是 | 卡槽ID。
- 0:卡槽1
- 1:卡槽2 | +| callback | Callback\<[SimStateData](#simstatedata7)\> | 是 | 回调函数。 | + +**示例:** + +``` +observer.on('simStateChange', {slotId: 0}, data =>{ + console.log("on simStateChange, data:" + JSON.stringify(data)); +}); +``` + + +## observer.off('simStateChange')7+ + +off\(type: 'simStateChange', callback?: Callback\\): void; + +移除订阅sim状态更改事件,使用callback方式作为异步方法。 + +>**说明:** +> +>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Telephony.StateRegistry + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | sim状态更改事件 | +| callback | Callback\<[SimStateData](#simstatedata7)\> | 否 | 回调函数。 | + +**示例:** + +``` +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'); +``` + + +## LockReason8+ + +SIM卡锁类型。 + +| 变量 | 值 | 说明 | +| ----------- | ---- | ------------------------------------------------------------ | +| SIM_NONE | 0 | 无锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PIN | 1 | PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PUK | 2 | PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PN_PIN | 3 | 网络PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PN_PUK | 4 | 网络PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PU_PIN | 5 | 子网PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PU_PUK | 6 | 子网PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PP_PIN | 7 | 服务提供商PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PP_PUK | 8 | 服务提供商PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PC_PIN | 9 | 组织PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_PC_PUK | 10 | 组织PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_SIM_PIN | 11 | SIM PIN锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| SIM_SIM_PUK | 12 | SIM PUK锁。
**系统能力**:SystemCapability.Telephony.StateRegistry | + + +## SimStateData7+ + +SIM卡类型和状态。 + +| 变量 | 类型 | 说明 | +| ----------------- | --------------------- | ------------------------------------------------------------ | +| type | [CardType](js-apis-sim.md#cardtype) | SIM卡类型,参考sim的[CardType](js-apis-sim.md#cardtype)。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| state | [SimState](js-apis-sim.md#SimState) | SIM卡状态,参考sim的[SimState](js-apis-sim.md#SimState)。
**系统能力**:SystemCapability.Telephony.StateRegistry | +| reason8+ | [LockReason](#lockreason8) | SIM卡锁类型。
**系统能力**:SystemCapability.Telephony.StateRegistry | + diff --git a/zh-cn/application-dev/reference/apis/js-apis-radio.md b/zh-cn/application-dev/reference/apis/js-apis-radio.md index 1d7b120625bd501e8f10cb603614947aefb800ae..e42486a49146657e9c306e38a96ce77c40fd76f4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-radio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-radio.md @@ -276,7 +276,56 @@ promise.then(data => { ``` -## radio.getSignalInformation +## radio.getPrimarySlotId7+ + +getPrimarySlotId\(callback: AsyncCallback\\): void + +获取主卡所在卡槽的索引号,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.CoreService + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback\ | 是 | 回调函数 | + +**示例:** + +``` +radio.getPrimarySlotId((err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); +``` + + +## radio.getPrimarySlotId7+ + +getPrimarySlotId\(\): Promise\ + +获取主卡所在卡槽的索引号,使用Promise方式作为异步方法。 + +**系统能力**:SystemCapability.Telephony.CoreService + +**返回值:** + +| 类型 | 说明 | +| ----------------------------------------------------------- | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回获取设备主卡所在卡槽的索引号的结果。 | + +**示例:** + +``` +let promise = radio.getPrimarySlotId(); +promise.then(data => { + console.log(`getPrimarySlotId success, promise: data->${JSON.stringify(data)}`); +}).catch(err => { + console.error(`getPrimarySlotId fail, promise: err->${JSON.stringify(err)}`); +}); +``` + + +## radio.getSignalInformation7+ getSignalInformation\(slotId: number, callback: AsyncCallback\>\): void @@ -301,7 +350,7 @@ radio.getSignalInformation(slotId, (err, data) => { ``` -## radio.getSignalInformation +## radio.getSignalInformation7+ getSignalInformation\(slotId: number\): Promise\> @@ -334,6 +383,35 @@ promise.then(data => { ``` +## radio.isNrSupported8+ + +isNrSupported\(slotId: number\): boolean + +判断当前设备是否支持5G\(NR\)。 + +**系统能力**:SystemCapability.Telephony.CoreService + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| slotId | number | 是 | 卡槽ID。
- 0:卡槽1
- 1:卡槽2 | + +**返回值:** + +| 类型 | 说明 | +| ------------------ | ------------------------------------------------------------ | +| boolean | - true:支持
- false:不支持 | + +**示例:** + +``` +let slotId = 0; +let result = radio.isNrSupported(slotId); +console.log(result); +``` + + ## radio.isRadioOn7+ isRadioOn\(callback: AsyncCallback\): void