Skip to content

D
Docs

OpenHarmony / Docs
接近 2 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 280b15b8 编写于 作者: C clevercong
浏览文件
操作

update js api reference. 

Signed-off-by: Nclevercong <lichunlin2@huawei.com>
上级 98d3da89
隐藏空白更改
内联 并排
Showing with 254 addition and 27 deletion
zh-cn/application-dev/reference/apis/js-apis-call.md
浏览文件 @ 280b15b8
......@@ -2742,13 +2742,13 @@ promise.then(data => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| extras | boolean | 否 | 根据extras的值判断是否为视频通话，默认为语音通话。<br/>- true：视频通话。<br/>- false：语音通话。 |
| accountId | number | 否 | 帐户Id。从API version 8开始支持。此接口为系统接口。 |
| videoState | [VideoStateType](#videostatetype7) | 否 | 视频状态类型。从API version 8开始支持。此接口为系统接口。 |
| dialScene | [DialScene](#dialscene8) | 否 | 拨号场景。从API version 8开始支持。此接口为系统接口。 |
| dialType | [DialType](#dialtype8) | 否 | 拨号类型。从API version 8开始支持。此接口为系统接口。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ |
| extras | boolean | 否 | 根据extras的值判断是否为视频通话，默认为语音通话。<br/>- true：视频通话。<br/>- false：语音通话。 |
| accountId | number <sup>8+</sup> | 否 | 帐户Id。从API version 8开始支持。此接口为系统接口。 |
| videoState | [VideoStateType](#videostatetype7) <sup>8+</sup> | 否 | 视频状态类型。从API version 8开始支持。此接口为系统接口。 |
| dialScene | [DialScene](#dialscene8) <sup>8+</sup> | 否 | 拨号场景。从API version 8开始支持。此接口为系统接口。 |
| dialType | [DialType](#dialtype8) <sup>8+</sup> | 否 | 拨号类型。从API version 8开始支持。此接口为系统接口。 |
## CallState
......
zh-cn/application-dev/reference/apis/js-apis-radio.md
浏览文件 @ 280b15b8
......@@ -1555,7 +1555,7 @@ radio.getPreferredNetwork(0, (err, data) => {
getPreferredNetwork(slotId: number): Promise<void\>
设置首选网络，使用Promise方式作为异步方法。
获取首选网络，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -1586,6 +1586,128 @@ promise.then(data => {
});
```
## radio.getImsRegInfo<sup>9+</sup>
getImsRegInfo(slotId: number, imsType: ImsServiceType, callback: AsyncCallback<ImsRegInfo\>): void
获取特定IMS服务类型的IMS注册状态信息，使用callback方式作为异步方法。
此接口为系统接口。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力**：SystemCapability.Telephony.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| imsType | [ImsServiceType](#imsservicetype9) | 是 | IMS服务类型。 |
| callback | AsyncCallback<[ImsRegInfo](#imsreginfo9)\> | 是 | 回调函数。 |
**示例：**
```js
radio.getImsRegInfo(0, 1, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## radio.getImsRegInfo<sup>9+</sup>
getImsRegInfo(slotId: number, imsType: ImsServiceType): Promise<ImsRegInfo\>
获取特定IMS服务类型的IMS注册状态信息，使用Promise方式作为异步方法。
此接口为系统接口。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力**：SystemCapability.Telephony.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| imsType | [ImsServiceType](#imsservicetype9) | 是 | IMS服务类型。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------- | ----------------------- |
| Promise\<[ImsRegInfo](#imsreginfo9)\> | 以Promise形式返回结果。 |
**示例：**
```js
let promise = radio.getImsRegInfo(0, 1);
promise.then(data => {
console.log(`getImsRegInfo success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
console.log(`getImsRegInfo fail, promise: err->${JSON.stringify(err)}`);
});
```
## radio.on('imsRegStateChange')<sup>9+</sup>
on(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback: Callback<ImsRegInfo\>): void
订阅imsRegStateChange事件，使用callback异步回调。
此接口为系统接口。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力**：SystemCapability.Telephony.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | -------------------------------------- |
| type | string | 是 | 监听IMS注册状态的变化。 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| imsType | [ImsServiceType](#imsservicetype9) | 是 | IMS服务类型。 |
| callback | Callback<[ImsRegInfo](#imsreginfo9)> | 是 | 回调函数。 |
**示例：**
```js
radio.on('imsRegStateChange', 0, 1, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## radio.off('imsRegStateChange')<sup>9+</sup>
off(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback?: Callback<ImsRegInfo\>): void
取消订阅imsRegStateChange事件，使用callback异步回调。
此接口为系统接口。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力**：SystemCapability.Telephony.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | -------------------------------------- |
| type | string | 是 | 通话结束时取消监听通话详情的变化。 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| imsType | [ImsServiceType](#imsservicetype9) | 是 | IMS服务类型。 |
| callback | Callback<[ImsRegInfo](#imsreginfo9)> | 否 | 回调函数。 |
**示例：**
```js
radio.off('imsRegStateChange', 0, 1, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## RadioTechnology
无线接入技术。
......@@ -1757,7 +1879,7 @@ promise.then(data => {
| isCamped | boolean | 获取服务单元的状态。 |
| timeStamp | number | 获取单元格信息时获取时间戳。 |
| signalInformation | [SignalInformation](#signalinformation) | 信号信息。 |
| data | [CdmaCellInformation](#cdmacellinformation) \| [GsmCellInformation](#gsmcellinformation) \| [LteCellInformation](#ltecellinformation) \| [NrCellInformation](#nrcellinformation) \| [TdscdmaCellInformation](#tdscdmacellinformation) | Cdma小区信息 \|Gsm小区信息\|Lte小区信息\|Nr小区信息\|Tdscdma小区信息 |
| data | [CdmaCellInformation](#cdmacellinformation8) \| [GsmCellInformation](#gsmcellinformation8) \| [LteCellInformation](#ltecellinformation8) \| [NrCellInformation](#nrcellinformation8) \| [TdscdmaCellInformation](#tdscdmacellinformation8) | Cdma小区信息 \|Gsm小区信息\|Lte小区信息\|Nr小区信息\|Tdscdma小区信息 |
## CdmaCellInformation<sup>8+</sup>
......@@ -1881,6 +2003,8 @@ Nr的选择模式。
网络搜索结果。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 类型 | 说明 |
......@@ -1933,3 +2057,58 @@ Nr的选择模式。
| networkInformation | [NetworkInformation](#networkinformation) | 网络信息。 |
| resumeSelection | boolean | 继续选择。 |
## ImsRegState<sup>9+</sup>
IMS注册状态。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ---------------- | ---- | -------- |
| IMS_UNREGISTERED | 0 | 未注册。 |
| IMS_REGISTERED | 1 | 已注册。 |
## ImsRegTech<sup>9+</sup>
IMS注册技术。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ----------------------- | ---- | --------------- |
| REGISTRATION_TECH_NONE | 0 | 无注册技术。 |
| REGISTRATION_TECH_LTE | 1 | LTE注册技术。 |
| REGISTRATION_TECH_IWLAN | 2 | IWLAN注册技术。 |
| REGISTRATION_TECH_NR | 3 | NR注册技术。 |
## ImsRegInfo<sup>9+</sup>
IMS注册信息。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 类型 | 说明 |
| ----------- | ---------------------------- | ------------- |
| imsRegState | [ImsRegState](#imsregstate9) | IMS注册状态。 |
| imsRegTech | [ImsRegTech](#imsregtech9) | IMS注册技术。 |
## ImsServiceType<sup>9+</sup>
IMS服务类型。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ---------- | ---- | ---------- |
| TYPE_VOICE | 0 | 语音服务。 |
| TYPE_VIDEO | 1 | 视频服务。 |
| TYPE_UT | 2 | UT服务。 |
| TYPE_SMS | 3 | 短讯服务。 |
zh-cn/application-dev/reference/apis/js-apis-sim.md
浏览文件 @ 280b15b8
......@@ -537,7 +537,7 @@ sim.getSimAccountInfo(0, (err, data) => {
getSimAccountInfo(slotId: number): Promise<IccAccountInfo\>
获取SIM卡账户信息，使用callback方式作为异步方法。
获取SIM卡账户信息，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -599,7 +599,7 @@ sim.getActiveSimAccountInfoList(0, (err, data) => {
getActiveSimAccountInfoList(): Promise<Array<IccAccountInfo\>>;
获取活跃SIM卡账户信息列表，使用callback方式作为异步方法。
获取活跃SIM卡账户信息列表，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -1110,7 +1110,7 @@ sim.setLockState(0, lockInfo, (err, data) => {
setLockState(slotId: number, options: LockInfo): Promise<LockStatusResponse\>
设置指定卡槽SIM卡的锁状态，使用callback方式作为异步方法。
设置指定卡槽SIM卡的锁状态，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -1178,7 +1178,7 @@ sim.getLockState(0, 1, (err, data) => {
getLockState(slotId: number, lockType: LockType): Promise<LockState\>
获取指定卡槽SIM卡的锁状态，使用callback方式作为异步方法。
获取指定卡槽SIM卡的锁状态，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -1242,7 +1242,7 @@ sim.alterPin(0, "1234", "0000", (err, data) => {
alterPin(slotId: number, newPin: string, oldPin: string): Promise<LockStatusResponse\>;
更改Pin密码，使用callback方式作为异步方法。
更改Pin密码，使用Promise方式作为异步方法。
此接口为系统接口。
......@@ -1482,7 +1482,7 @@ promise.then(data => {
## sim.**unlockPin**2<sup>8+</sup>
****unlockPin2****(slotId: number,pin2: string ,callback: AsyncCallback<LockStatusResponse\>): void
unlockPin2(slotId: number,pin2: string ,callback: AsyncCallback<LockStatusResponse\>): void
解锁指定卡槽SIM卡密码，使用callback方式作为异步方法。
......@@ -1549,7 +1549,7 @@ promise.then(data => {
## sim.**unlockPuk**2<sup>8+</sup>
unlockPuk2(slotId: number,newPin2: string,puk2: string ,callback: AsyncCallback<LockStatusResponse\>): void
unlockPuk2(slotId: number, newPin2: string, puk2: string, callback: AsyncCallback<LockStatusResponse\>): void
解锁指定卡槽SIM卡密码的解锁密码，使用callback方式作为异步方法。
......@@ -1581,7 +1581,7 @@ sim.unlockPuk2(0, newPin2, puk2, (err, data) => {
## sim.**unlockPuk2**<sup>8+</sup>
unlockPuk2slotId: number,newPin2: string,puk2: string): Promise&lt;LockStatusResponse\>
unlockPuk2(slotId: number, newPin2: string, puk2: string): Promise&lt;LockStatusResponse\>
解锁指定卡槽SIM卡密码的解锁密码，使用Promise方式作为异步方法。
......@@ -2653,7 +2653,7 @@ promise.then(data => {
## sim.getOpKey<sup>9+</sup>
getOpKey(slotId: number, callback: AsyncCallback<number\>): void
getOpKey(slotId: number, callback: AsyncCallback<string\>): void
获取指定卡槽中SIM卡的opkey，使用callback方式作为异步方法。
......@@ -2666,7 +2666,7 @@ getOpKey(slotId: number, callback: AsyncCallback<number\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback<number\> | 是 | 回调函数 |
| callback | AsyncCallback<string\> | 是 | 回调函数。 |
**示例：**
......@@ -2679,7 +2679,7 @@ sim.getOpKey(0, (err, data) => {
## sim.getOpKey<sup>9+</sup>
getOpKey(slotId: number): Promise<number\>
getOpKey(slotId: number): Promise<string\>
获取指定卡槽中SIM卡的opkey，使用Promise方式作为异步方法。
......@@ -2697,7 +2697,7 @@ getOpKey(slotId: number): Promise<number\>
| 类型 | 说明 |
| ---------------- | ----------------------------------------- |
| Promise<number\> | 以Promise形式返回指定卡槽中SIM卡的opkey。 |
| Promise<string\> | 以Promise形式返回指定卡槽中SIM卡的opkey。 |
**示例：**
......@@ -2948,3 +2948,34 @@ Icc账户信息。
| :-------------- | ---- | ---------- |
| GENERAL_CONTACT | 1 | 通用联系人 |
| FIXED_DIALING | 2 | 固定拨号 |
## OperatorConfigKey<sup>9+</sup>
运营商配置。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------- |
| KEY_VOICE_MAIL_NUMBER_STRING | voice_mail_number_string | 语音邮件号码 |
| KEY_IMS_SWITCH_ON_BY_DEFAULT_BOOL | ims_switch_on_by_default_bool | 用户设置IMS通话开关默认值 |
| KEY_HIDE_IMS_SWITCH_BOOL | hide_ims_switch_bool | 隐藏IMS通话开关菜单 |
| KEY_VOLTE_SUPPORTED_BOOL | volte_supported_bool | 是否支持volte |
| KEY_NR_MODE_SUPPORTED_LIST_INT_ARRAY | nr_mode_supported_list_int_array | 支持NR模式(SA，NSA)列表 |
| KEY_VOLTE_PROVISIONING_SUPPORTED_BOOL | volte_provisioning_supported_bool | 是否支持volte的PROVISIONING配置 |
| KEY_SS_OVER_UT_SUPPORTED_BOOL | ss_over_ut_supported_bool | 是否支持UT设置补充业务 |
| KEY_IMS_GBA_REQUIRED_BOOL | ims_gba_required_bool | 是否允许插入有GBA能力的SIM卡时才能使用IMS |
| KEY_UT_PROVISIONING_SUPPORTED_BOOL | ut_provisioning_supported_bool | 是否支持UT的PROVISIONING配置 |
| KEY_IMS_PREFER_FOR_EMERGENCY_BOOL | ims_prefer_for_emergency_bool | 是否优先使用IMS用于紧急情况 |
| KEY_CALL_WAITING_SERVICE_CLASS_INT | call_waiting_service_class_int | 设置呼叫等待服务类 |
| KEY_CALL_TRANSFER_VISIBILITY_BOOL | call_transfer_visibility_bool | 呼叫转移可见性 |
| KEY_IMS_CALL_DISCONNECT_REASONINFO_MAPPING_STRING_ARRAY | ims_call_disconnect_reasoninfo_mapping_string_array | ims通话断开原因信息 |
| KEY_FORCE_VOLTE_SWITCH_ON_BOOL | force_volte_switch_on_bool | 强制打开volte |
| KEY_ENABLE_OPERATOR_NAME_CUST_BOOL | enable_operator_name_cust_bool | 打开运营商定制名字 |
| KEY_OPERATOR_NAME_CUST_STRING | operator_name_cust_string | 定制运营商名字 |
| KEY_SPN_DISPLAY_CONDITION_CUST_INT | spn_display_condition_cust_int | 显示spn定制条件 |
| KEY_PNN_CUST_STRING_ARRAY | pnn_cust_string_array | pnn定制 |
| KEY_OPL_CUST_STRING_ARRAY | opl_cust_string_array | opl定制 |
| KEY_EMERGENCY_CALL_STRING_ARRAY | emergency_call_string_array | 紧急呼叫 |
zh-cn/application-dev/reference/apis/js-apis-sms.md
浏览文件 @ 280b15b8
......@@ -678,7 +678,7 @@ getAllSimMessages(slotId: number, callback: AsyncCallback<Array<SimShortMessage\
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ----------------------------------------- |
| slotId | number | 是 | SIM卡槽ID：<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback<Array<[SimShortMessage](#simshortmessage8)\>> | 是 | 回调函数。 |
| callback | AsyncCallback<Array<[SimShortMessage](#simshortmessage7)\>> | 是 | 回调函数。 |
**示例：**
......@@ -712,7 +712,7 @@ getAllSimMessages(slotId: number): Promise<Array<SimShortMessage\>>
| 类型 | 说明 |
| ------------------------------------------------------- | ---------------------------------- |
| PromiseArray<[SimShortMessage](#simshortmessage8)\>&gt; | 以Promise形式返回获取的SIM短消息。 |
| PromiseArray<[SimShortMessage](#simshortmessage7)\>&gt; | 以Promise形式返回获取的SIM短消息。 |
**示例：**
......@@ -742,7 +742,7 @@ setCBConfig(options: CBConfigOptions, callback: AsyncCallback<void\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------ |
| options | [CBConfigOptions](#cbconfigoptions8) | 是 | 小区广播配置选项。 |
| options | [CBConfigOptions](#cbconfigoptions7) | 是 | 小区广播配置选项。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
......@@ -776,7 +776,7 @@ setCBConfig(options: CBConfigOptions): Promise<void\>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------ | ---- | ------------ |
| options | [CBConfigOptions](#cbconfigoptions8) | 是 | 小区广播配置选项。 |
| options | [CBConfigOptions](#cbconfigoptions7) | 是 | 小区广播配置选项。 |
**返回值：**
......@@ -1330,6 +1330,23 @@ promise.then(data => {
| date | number | 是 | 日期 |
| readStatus | number | 是 | 阅读状态 |
## MmsReadRecInd<sup>8+</sup>
彩信读取记录索引。
此接口为系统接口。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------- | ---- | -------- |
| version | [MmsVersionType](#mmsversiontype8) | 是 | 版本 |
| messageId | string | 是 | 消息ID |
| to | Array<[MmsAddress](#mmsaddress8)\> | 是 | 发送至 |
| from | [MmsAddress](#mmsaddress8) | 是 | 来源 |
| readStatus | number | 是 | 阅读状态 |
| date | number | 否 | 日期 |
## MmsAttachment<sup>8+</sup>
彩信附件。
......@@ -1465,7 +1482,7 @@ promise.then(data => {
| MMS_YES | 128 | YES |
| MMS_NO | 129 | NO |
## CBConfigOptions<sup>8+</sup>
## CBConfigOptions<sup>7+</sup>
小区广播配置选项。
......@@ -1556,7 +1573,7 @@ SIM卡消息选项。
| pdu | string | 是 | 协议数据单元 |
| smsc | string | 是 | 短消息业务中心 |
## SimShortMessage<sup>8+</sup>
## SimShortMessage<sup>7+</sup>
SIM卡短消息。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或