未验证 提交 90c707b6 编写于 作者: O openharmony_ci 提交者: Gitee

!1818 radio和obsever api文档更新

Merge pull request !1818 from 刘建东/master
...@@ -263,3 +263,279 @@ observer.on('callStateChange', callback); ...@@ -263,3 +263,279 @@ observer.on('callStateChange', callback);
observer.off('callStateChange', callback); observer.off('callStateChange', callback);
observer.off('callStateChange'); observer.off('callStateChange');
``` ```
## observer.on('cellularDataConnectionStateChange')<sup>7+</sup><a name=observer.on.cellularDataConnectionStateChange-callback></a>
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')<sup>7+</sup><a name=observer.on.cellularDataConnectionStateChange.options-callback></a>
on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, callback: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void;
订阅指定卡槽位的蜂窝数据链路连接状态,使用callback方式作为异步方法。
**系统能力**:SystemCapability.Telephony.StateRegistry
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0:卡槽1<br/>- 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')<sup>7+</sup><a name=observer.off.cellularDataConnectionStateChange-callback></a>
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')<sup>7+</sup><a name=observer.on.cellularDataFlowChange-callback></a>
on\(type: 'cellularDataFlowChange', callback: Callback\<DataFlowType\>\): 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')<sup>7+</sup><a name=observer.on.cellularDataFlowChange.options-callback></a>
on\(type: 'cellularDataFlowChange', options: { slotId: number }, callback: Callback\<DataFlowType\>\): void;
订阅指定卡槽位的蜂窝数据业务的上下行数据流状态,使用callback方式作为异步方法。
**系统能力**:SystemCapability.Telephony.StateRegistry
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0:卡槽1<br/>- 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')<sup>7+</sup><a name=observer.off.cellularDataFlowChange-callback></a>
off\(type: 'cellularDataFlowChange', callback?: Callback\<DataFlowType\>\): 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')<sup>7+</sup><a name=observer.on.simStateChange-callback></a>
on\(type: 'simStateChange', callback: Callback\<SimStateData\>\): 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')<sup>7+</sup><a name=observer.on.simStateChange.options-callback></a>
on\(type: 'simStateChange', options: { slotId: number }, callback: Callback\<SimStateData\>\): void;
订阅指定卡槽位的sim状态更改事件,使用callback方式作为异步方法。
**系统能力**:SystemCapability.Telephony.StateRegistry
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | sim状态更改事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0:卡槽1<br/>- 1:卡槽2 |
| callback | Callback\<[SimStateData](#simstatedata7)\> | 是 | 回调函数。 |
**示例:**
```
observer.on('simStateChange', {slotId: 0}, data =>{
console.log("on simStateChange, data:" + JSON.stringify(data));
});
```
## observer.off('simStateChange')<sup>7+</sup><a name=observer.off.simStateChange-callback></a>
off\(type: 'simStateChange', callback?: Callback\<SimStateData\>\): 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');
```
## LockReason<sup>8+</sup>
SIM卡锁类型。
| 变量 | 值 | 说明 |
| ----------- | ---- | ------------------------------------------------------------ |
| SIM_NONE | 0 | 无锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PIN | 1 | PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PUK | 2 | PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PN_PIN | 3 | 网络PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PN_PUK | 4 | 网络PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PU_PIN | 5 | 子网PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PU_PUK | 6 | 子网PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PP_PIN | 7 | 服务提供商PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PP_PUK | 8 | 服务提供商PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PC_PIN | 9 | 组织PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_PC_PUK | 10 | 组织PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_SIM_PIN | 11 | SIM PIN锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| SIM_SIM_PUK | 12 | SIM PUK锁。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
## SimStateData<sup>7+</sup>
SIM卡类型和状态。
| 变量 | 类型 | 说明 |
| ----------------- | --------------------- | ------------------------------------------------------------ |
| type | [CardType](js-apis-sim.md#CardType) | SIM卡类型,参考sim的[CardType](js-apis-sim.md#CardType)<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| state | [SimState](js-apis-sim.md#SimState) | SIM卡状态,参考sim的[SimState](js-apis-sim.md#SimState)<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
| reason<sup>8+</sup> | [LockReason](#lockreason8) | SIM卡锁类型。<br/>**系统能力**:SystemCapability.Telephony.StateRegistry |
...@@ -276,7 +276,56 @@ promise.then(data => { ...@@ -276,7 +276,56 @@ promise.then(data => {
``` ```
## radio.getSignalInformation<a name=radio.getSignalInformation-callback></a> ## radio.getPrimarySlotId<sup>7+</sup><a name=radio.getPrimarySlotId-callback></a>
getPrimarySlotId\(callback: AsyncCallback\<number\>\): void
获取主卡所在卡槽的索引号,使用callback方式作为异步方法。
**系统能力**:SystemCapability.Telephony.CoreService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number\> | 是 | 回调函数 |
**示例:**
```
radio.getPrimarySlotId((err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## radio.getPrimarySlotId<sup>7+</sup><a name=radio.getPrimarySlotId-promise></a>
getPrimarySlotId\(\): Promise\<number\>
获取主卡所在卡槽的索引号,使用Promise方式作为异步方法。
**系统能力**:SystemCapability.Telephony.CoreService
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<number\> | 以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.getSignalInformation<sup>7+</sup><a name=radio.getSignalInformation-callback></a>
getSignalInformation\(slotId: number, callback: AsyncCallback<Array<SignalInformation\>\>\): void getSignalInformation\(slotId: number, callback: AsyncCallback<Array<SignalInformation\>\>\): void
...@@ -301,7 +350,7 @@ radio.getSignalInformation(slotId, (err, data) => { ...@@ -301,7 +350,7 @@ radio.getSignalInformation(slotId, (err, data) => {
``` ```
## radio.getSignalInformation<a name=radio.getSignalInformation-promise></a> ## radio.getSignalInformation<sup>7+</sup><a name=radio.getSignalInformation-promise></a>
getSignalInformation\(slotId: number\): Promise<Array<SignalInformation\>\> getSignalInformation\(slotId: number\): Promise<Array<SignalInformation\>\>
...@@ -334,6 +383,35 @@ promise.then(data => { ...@@ -334,6 +383,35 @@ promise.then(data => {
``` ```
## radio.isNrSupported<sup>8+</sup><a name=radio.isNrSupported.slot></a>
isNrSupported\(slotId: number\): boolean
判断当前设备是否支持5G\(NR\)
**系统能力**:SystemCapability.Telephony.CoreService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0:卡槽1<br/>- 1:卡槽2 |
**返回值:**
| 类型 | 说明 |
| ------------------ | ------------------------------------------------------------ |
| boolean | - true:支持<br/>- false:不支持 |
**示例:**
```
let slotId = 0;
let result = radio.isNrSupported(slotId);
console.log(result);
```
## radio.isRadioOn<sup>7+</sup><a name=radio.isRadioOn-callback></a> ## radio.isRadioOn<sup>7+</sup><a name=radio.isRadioOn-callback></a>
isRadioOn\(callback: AsyncCallback<boolean\>\): void isRadioOn\(callback: AsyncCallback<boolean\>\): void
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册