Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 ba241cc9 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1979 翻译已完成 1803#I4WOML 

Merge pull request !1979 from shawn_he/call-1
上级 1a3f1add 0a19bfa8
展开全部 显示空白变更内容
内联 并排
Showing with 228 addition and 136 deletion
en/application-dev/reference/apis/js-apis-call.md
浏览文件 @ ba241cc9
...@@ -23,10 +23,10 @@ Initiates a call. This function uses an asynchronous callback to return the exec ...@@ -23,10 +23,10 @@ Initiates a call. This function uses an asynchronous callback to return the exec
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | ------------------------------------------------- | | ----------- | ---------------------------- | ---- | ------------------------------------------------- |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result.<br/> - **true**: success <br/> - **false**: failure| | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example** **Example**
...@@ -49,11 +49,11 @@ Initiates a call. You can set call options as needed. This function uses an asyn ...@@ -49,11 +49,11 @@ Initiates a call. You can set call options as needed. This function uses an asyn
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | ------------------------------------------------- | | ----------- | ---------------------------- | ---- | ------------------------------------------------- |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | DialOptions | Yes| Call options. For details, see [DialOptions](#DialOptions).| | options | DialOptions | Yes | Call options. For details, see [DialOptions](#DialOptions). |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result.<br/> - **true**: success <br/> - **false**: failure| | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example** **Example**
...@@ -78,14 +78,14 @@ Initiates a call. You can set call options as needed. This function uses a promi ...@@ -78,14 +78,14 @@ Initiates a call. You can set call options as needed. This function uses a promi
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ----------- | ---- | ------------------------------------------- | | ----------- | ----------- | ---- | ------------------------------------------- |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | DialOptions | Yes| Call options. For details, see [DialOptions](#DialOptions).| | options | DialOptions | Yes | Call options. For details, see [DialOptions](#DialOptions).|
**Return value** **Return Value**
| Type| Description| | Type | Description |
| ---------------------- | --------------------------------- | | ---------------------- | --------------------------------- |
| Promise&lt;boolean&gt; | Promise used to return the result.| | Promise&lt;boolean&gt; | Promise used to return the result.|
...@@ -102,6 +102,61 @@ promise.then(data => { ...@@ -102,6 +102,61 @@ promise.then(data => {
}); });
``` ```
## call.makeCall<sup>7+</sup><a name=call.makeCall-callback></a>
makeCall(phoneNumber: string, callback: AsyncCallback<void>): void
Launches the call screen and displays the dialed number. This method uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ------------------------- | ---- | ------------------------------------------ |
| phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
**Example**
```
call.makeCall("138xxxxxxxx", err => {
console.log(`makeCall callback: err->${JSON.stringify(err)}`);
});
```
## call.makeCall<sup>7+</sup><a name=call.makeCall-promise></a>
makeCall(phoneNumber: string): Promise<void>
Launches the call screen and displays the dialed number. This method uses a promise to return the result.
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ------ | ---- | ---------- |
| phoneNumber | string | Yes | Phone number.|
**Return Value**
| Type | Description |
| ------------------- | --------------------------------- |
| Promise&lt;void&gt; | Promise used to return the result.|
**Example**
```
let promise = call.makeCall("138xxxxxxxx");
promise.then(() => {
console.log(`makeCall success`);
}).catch(err => {
console.error(`makeCall fail, promise: err->${JSON.stringify(err)}`);
});
```
## call.hasCall<a name=call.hasCall-callback></a> ## call.hasCall<a name=call.hasCall-callback></a>
hasCall\(callback: AsyncCallback<boolean\>\): void hasCall\(callback: AsyncCallback<boolean\>\): void
...@@ -112,9 +167,9 @@ Checks whether a call is in progress. This function uses an asynchronous callbac ...@@ -112,9 +167,9 @@ Checks whether a call is in progress. This function uses an asynchronous callbac
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result: <br/> - **true**: A call is in progress. <br/> - **false**: No call is in progress. | | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: A call is in progress.<br>- **false**: No call is in progress.|
**Example** **Example**
...@@ -133,9 +188,9 @@ Checks whether a call is in progress. This function uses a promise to return the ...@@ -133,9 +188,9 @@ Checks whether a call is in progress. This function uses a promise to return the
**System capability**: SystemCapability.Telephony.CallManager **System capability**: SystemCapability.Telephony.CallManager
**Return value** **Return Value**
| Type| Description| | Type | Description |
| ---------------------- | --------------------------------------- | | ---------------------- | --------------------------------------- |
| Promise&lt;boolean&gt; | Promise used to return the result.| | Promise&lt;boolean&gt; | Promise used to return the result.|
...@@ -161,9 +216,9 @@ Obtains the call status. This function uses an asynchronous callback to return t ...@@ -161,9 +216,9 @@ Obtains the call status. This function uses an asynchronous callback to return t
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | -------------------------------------------- | ---- | ------------------------------------ | | -------- | -------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[CallState](#CallState)&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;[CallState](#CallState)&gt; | Yes | Callback used to return the result.|
**Example** **Example**
...@@ -182,9 +237,9 @@ Obtains the call status. This function uses a promise to return the result. ...@@ -182,9 +237,9 @@ Obtains the call status. This function uses a promise to return the result.
**System capability**: SystemCapability.Telephony.CallManager **System capability**: SystemCapability.Telephony.CallManager
**Return value** **Return Value**
| Type| Description| | Type | Description |
| -------------------------------------- | ----------------------------------------- | | -------------------------------------- | ----------------------------------------- |
| Promise&lt;[CallState](#CallState)&gt; | Promise used to return the result.| | Promise&lt;[CallState](#CallState)&gt; | Promise used to return the result.|
...@@ -199,6 +254,25 @@ promise.then(data => { ...@@ -199,6 +254,25 @@ promise.then(data => {
}); });
``` ```
## call.hasVoiceCapability<sup>7+</sup><a name=call.hasVoiceCapability></a>
hasVoiceCapability(): boolean
Checks whether a device supports voice calls. This function works in synchronous mode.
**System capability**: SystemCapability.Telephony.CallManager
**Return Value**
| Type | Description |
| ------- | ------------------------------------------------------------ |
| boolean | - **true**: The device supports voice calls.<br>- **false**: The device does not support voice calls.|
```
let result = call.hasVoiceCapability();
console.log(`hasVoiceCapability: ${JSON.stringify(result)}`);
```
## call.isEmergencyPhoneNumber<sup>7+</sup><a name=call.isEmergencyPhoneNumber-callback1></a> ## call.isEmergencyPhoneNumber<sup>7+</sup><a name=call.isEmergencyPhoneNumber-callback1></a>
isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
...@@ -209,10 +283,10 @@ Checks whether the call number of the SIM card in the specified slot is an emerg ...@@ -209,10 +283,10 @@ Checks whether the call number of the SIM card in the specified slot is an emerg
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result.<br/> - **true**: The called number is an emergency number. <br/> - **false**: The called number is not an emergency number.| | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: The called number is an emergency number.<br>- **false**: The called number is not an emergency number.|
**Example** **Example**
...@@ -233,11 +307,11 @@ Checks whether the call number of the SIM card in the specified slot is an emerg ...@@ -233,11 +307,11 @@ Checks whether the call number of the SIM card in the specified slot is an emerg
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | EmergencyNumberOptions | Yes| Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).| | options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).|
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the result.<br/> - **true**: The called number is an emergency number. <br/> - **false**: The called number is not an emergency number.| | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: The called number is an emergency number.<br>- **false**: The called number is not an emergency number.|
**Example** **Example**
...@@ -258,14 +332,14 @@ Checks whether the call number of the SIM card in the specified slot is an emerg ...@@ -258,14 +332,14 @@ Checks whether the call number of the SIM card in the specified slot is an emerg
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ---------------------- | ---- | ------------------------------------------------------------ | | ----------- | ---------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | EmergencyNumberOptions | Yes| Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).| | options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).|
**Return value** **Return Value**
| Type| Description| | Type | Description |
| ---------------------- | --------------------------------------------------- | | ---------------------- | --------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise used to return the result.| | Promise&lt;boolean&gt; | Promise used to return the result.|
...@@ -290,10 +364,10 @@ Formats a phone number based on the specified ISO country code. This function us ...@@ -290,10 +364,10 @@ Formats a phone number based on the specified ISO country code. This function us
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | --------------------------- | ---- | ------------------------------------ | | ----------- | --------------------------- | ---- | ------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result.|
**Example** **Example**
...@@ -314,11 +388,11 @@ Formats a phone number based on specified formatting options. This function uses ...@@ -314,11 +388,11 @@ Formats a phone number based on specified formatting options. This function uses
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ | | ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | NumberFormatOptions | Yes| Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).| | options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).|
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. |
**Example** **Example**
...@@ -341,14 +415,14 @@ Formats a phone number based on specified formatting options. This function uses ...@@ -341,14 +415,14 @@ Formats a phone number based on specified formatting options. This function uses
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ------------------- | ---- | ------------------------------------------------------------ | | ----------- | ------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| options | NumberFormatOptions | Yes| Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).| | options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).|
**Return value** **Return Value**
| Type| Description| | Type | Description |
| --------------------- | ------------------------------------------- | | --------------------- | ------------------------------------------- |
| Promise&lt;string&gt; | Promise used to return the result.| | Promise&lt;string&gt; | Promise used to return the result.|
...@@ -379,11 +453,11 @@ All country codes are supported. ...@@ -379,11 +453,11 @@ All country codes are supported.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | --------------------------- | ---- | ----------------------------------------------------- | | ----------- | --------------------------- | ---- | ----------------------------------------------------- |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| countryCode | string | Yes| Country code, for example, **CN** (China). All country codes are supported.| | countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported. |
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result.|
**Example** **Example**
...@@ -410,14 +484,14 @@ All country codes are supported. ...@@ -410,14 +484,14 @@ All country codes are supported.
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ----------- | ------ | ---- | ---------------------------------------- | | ----------- | ------ | ---- | ---------------------------------------- |
| phoneNumber | string | Yes| Phone number.| | phoneNumber | string | Yes | Phone number. |
| countryCode | string | Yes| Country code, for example, **CN** (China). All country codes are supported.| | countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported.|
**Return value** **Return Value**
| Type| Description| | Type | Description |
| --------------------- | ------------------------------------------------------------ | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise used to return the result.| | Promise&lt;string&gt; | Promise used to return the result.|
...@@ -440,20 +514,20 @@ Provides an option for determining whether a call is a video call. ...@@ -440,20 +514,20 @@ Provides an option for determining whether a call is a video call.
**System capability**: SystemCapability.Telephony.CallManager **System capability**: SystemCapability.Telephony.CallManager
| Name| Type| Mandatory| Description| | Parameter | Type | Mandatory| Description |
| ------ | ------- | ---- | ------------------------------------------------------------ | | ------ | ------- | ---- | ------------------------------------------------------------ |
| extras | boolean | No| Indication of a video call. The options are as follows: <br/> - **true**: video call <br/> - **false**: voice call| | extras | boolean | No | Indication of a video call. <br>- **true**: video call<br>- **false** (default): voice call|
## CallState<a name=CallState></a> ## CallState<a name=CallState></a>
Enumerates call states. Enumerates call states.
| Variable| Value| Description| | Variable | Value | Description |
| ------------------ | ---- | ------------------------------------------------------------ | | ------------------ | ---- | ------------------------------------------------------------ |
| CALL_STATE_UNKNOWN | -1 | The call status fails to be obtained and is unknown. <br />**System capability**: SystemCapability.Telephony.CallManager| | CALL_STATE_UNKNOWN | -1 | The call status fails to be obtained and is unknown.<br>**System capability**: SystemCapability.Telephony.CallManager|
| CALL_STATE_IDLE | 0 | No call is in progress. <br />**System capability**: SystemCapability.Telephony.CallManager| | CALL_STATE_IDLE | 0 | No call is in progress.<br>**System capability**: SystemCapability.Telephony.CallManager|
| CALL_STATE_RINGING | 1 | The call is in the ringing or waiting state. <br />**System capability**: SystemCapability.Telephony.CallManager| | CALL_STATE_RINGING | 1 | The call is in the ringing or waiting state.<br>**System capability**: SystemCapability.Telephony.CallManager|
| CALL_STATE_OFFHOOK | 2 | At least one call is in dialing, active, or on hold, and no new incoming call is ringing or waiting. <br />**System capability**: SystemCapability.Telephony.CallManager| | CALL_STATE_OFFHOOK | 2 | At least one call is in dialing, active, or on hold, and no new incoming call is ringing or waiting.<br>**System capability**: SystemCapability.Telephony.CallManager|
## EmergencyNumberOptions<sup>7+</sup><a name=EmergencyNumberOptions></a> ## EmergencyNumberOptions<sup>7+</sup><a name=EmergencyNumberOptions></a>
...@@ -461,9 +535,9 @@ Provides an option for determining whether a number is an emergency number for t ...@@ -461,9 +535,9 @@ Provides an option for determining whether a number is an emergency number for t
**System capability**: SystemCapability.Telephony.CallManager **System capability**: SystemCapability.Telephony.CallManager
| Name| Type| Mandatory| Description| | Parameter | Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------ |
| slotId | number | No| SIM card slot ID.<br/> - **0**: slot 1 <br/> - **1**: slot 2| | slotId | number | No | Card slot ID. <br>- **0**: card slot 1<br>- **1**: card slot 2|
## NumberFormatOptions<sup>7+</sup><a name=NumberFormatOptions></a> ## NumberFormatOptions<sup>7+</sup><a name=NumberFormatOptions></a>
...@@ -471,6 +545,6 @@ Provides an option for number formatting. ...@@ -471,6 +545,6 @@ Provides an option for number formatting.
**System capability**: SystemCapability.Telephony.CallManager **System capability**: SystemCapability.Telephony.CallManager
| Name| Type| Mandatory| Description| | Parameter | Type | Mandatory| Description |
| ----------- | ------ | ---- | ---------------------------------------------------------- | | ----------- | ------ | ---- | ---------------------------------------------------------- |
| countryCode | string | No| Country code, for example, **CN** (China). All country codes are supported. The default value is **CN**.| | countryCode | string | No | Country code, for example, **CN** (China). All country codes are supported. The default value is **CN**.|
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或