TelephoneNumberUtils

java.lang.Object
- ohos.telephony.TelephoneNumberUtils

```
public class TelephoneNumberUtils
extends Object
```
Provides utilities to process phone numbers.
Applications can use the methods in this class to deal with phone numbers.

从以下版本开始:

1

字段概要

字段
限定符和类型	字段	说明
`static int`	`BCD_EXT_TYPE_CALLED_PARTY`	Indicates the called party BCD number type.
`static int`	`BCD_EXT_TYPE_EF_ADN`	Indicates the abbreviated dialing number type.
`static int`	`INTERNATIONAL_TON_VALUE`	Indicates the international number type.
`static char`	`PAUSE`	'p' - Indicates the PAUSE character defined in the ETSI GSM specifications.
`static int`	`UNKNOWN_TON_VALUE`	Indicates an unknown number type.
`static char`	`WAIT`	'w' - Indicates the WAIT character defined in the ETSI GSM specifications.
`static char`	`WILD`	'n' - Indicates the WILD character defined in the ETSI GSM specifications.

构造器概要

构造器
构造器说明

TelephoneNumberUtils()

构造器
构造器	说明
`TelephoneNumberUtils()`

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法	说明
`static String`	`changeKeypadLettersToDigits(String data)`	Converts any alphabetic letter ([A-Z] or [a-z]) in a phone number to an equivalent digit according to the phone keyboard mapping described in ITU E.161 and ISO/IEC 9995-8.
`static boolean`	`comparePhoneNumbers(String phoneNumberA, String phoneNumberB)`	Compares two phone numbers.
`static String`	`convertCalledPartyBCDToStringWithoutTOA(byte[] data, int offset, int calledPartyBCDNumberLength, int bcdExtendedType)`	Converts a called party BCD number without the TOA field.
`static String`	`convertCalledPartyBCDToStringWithTOA(byte[] data, int offset, int calledPartyBCDNumberLength, int bcdExtendedType)`	Converts a called party binary-coded decimal (BCD) number carrying the TOA field.
`static String`	`convertPhoneNumber(String phoneNumber)`	Converts the character 'p' or 'P' in a phone number to a comma (,), and the character "w" or "W" to a semicolon (;).
`static String`	`extractNetworkAddressPortion(String phoneNumber)`	Extracts the network address and standardizes it by filtering out separators.
`static String`	`extractNetworkAddressPortionPlus(String phoneNumber)`	Extracts the network address from a phone number and standardizes it by filtering out separators (excluding the plus sign (+), if available).
`static String`	`extractPostDialPortion(String phoneNumber)`	Obtains the dual-tone multifrequency (DTMF) control bit, pause character, and wait character from a phone number.
`static String`	`formatPhoneNumber(String phoneNumber)`	Formats a phone number according to the Chinese Telephone Code Plan.
`static String`	`formatPhoneNumber(String phoneNumber, String defaultCountryCode)`	Formats a phone number.
`static String`	`formatPhoneNumber(String phoneNumber, String phoneNumberE164, String defaultCountryCode)`	Formats a phone number according to the country code.
`static String`	`formatPhoneNumberToE164(String phoneNumber, String defaultCountryCode)`	Formats a phone number into an E.164 representation.
`static String`	`getCountryIsoFromDbNumber(String phoneNumber)`	Obtains the ISO country code of a phone number from the database.
`static int`	`getIntlPrefixAndCCLen(String phoneNumber)`	Obtains the prefix length of a specified phone number.
`static boolean`	`isDialableDtmfKey(char input)`	Checks whether an input character is one of the 12 dialable DTMF keys on the dialer, which are digits 0-9, the star key (*), and the pound key (#).
`static boolean`	`isDialableKey(char input)`	Checks whether an input character is dialable, that is, a digit ranging from 0 to 9, the star key (*), the pound key (#), the plus sign (+), or WILD.
`static boolean`	`isDialTwelveKey(char input)`	已过时。
`static boolean`	`isEmergencyPhoneNumber(String phoneNumber)`	Checks whether a phone number is on the emergency number list.
`static boolean`	`isInternationalPhoneNumber(String phoneNumber)`	Checks whether a phone number is in the international number format.
`static boolean`	`isLatinDigit(char input)`	Checks whether an input character is a latin digit ranging from 0 to 9.
`static boolean`	`isLocalEmergencyPhoneNumber(String phoneNumber)`	Checks whether a phone number is an emergency number of the country where the calling party is located.
`static boolean`	`isNotSeparator(char input)`	Checks whether an input character is a non-separator.
`static boolean`	`isReallyDialableKey(char input)`	Checks whether an input character is a digit ranging from 0 to 9, the star key (*), the pound key (#), or the plus sign (+).
`static boolean`	`isSuitableSmsAddress(String address)`	Checks whether the network address of the Short Message Service (SMS) can be used as the destination address.
`static boolean`	`isUriPhoneNumber(String phoneNumber)`	Checks whether a phone number contains '@' or '%40' to determine whether the phone number is a URI.
`static boolean`	`isVoiceMailNumber(String phoneNumber, int slotId)`	Checks whether a phone number is on the voice mailbox number list provided by the SIM card.
`static boolean`	`isWaitOrPauseChar(char c)`	Checks whether a character is a wait or pause character.
`static String`	`normalizePhoneNumber(String phoneNumber)`	Normalizes a phone number by deleting characters other than digits.
`static String`	`removeSeparators(String phoneNumber)`	Removes separators from a phone number.
`static String`	`replacePauseAndWaitChar(String phoneNumber)`	Replaces pause characters with semicolons and waiting characters with commas in a specified phone number.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - BCD_EXT_TYPE_CALLED_PARTY
```
public static final int BCD_EXT_TYPE_CALLED_PARTY
```
    Indicates the called party BCD number type. It is one of the BCD extension types and is used to identify extension characters that are greater than 9. For details, see section 10.5.4.7 "Called party BCD number" in 3GPP TS 24.008.
    
    另请参阅:
    
    常量字段值
  - BCD_EXT_TYPE_EF_ADN
```
public static final int BCD_EXT_TYPE_EF_ADN
```
    Indicates the abbreviated dialing number type. It is one of the BCD extension types and is used to identify extension characters that are greater than 9. For details, see section 10.5.1 "Abbreviated dialing numbers" in 3GPP TS 51.011.
    
    另请参阅:
    
    常量字段值
  - INTERNATIONAL_TON_VALUE
```
public static final int INTERNATIONAL_TON_VALUE
```
    Indicates the international number type. For details, see section 10.5.4.7 "Called party BCD number" in 3GPP TS 24.008.
    
    另请参阅:
    
    常量字段值
  - PAUSE
```
public static final char PAUSE
```
    'p' - Indicates the PAUSE character defined in the ETSI GSM specifications.
    
    另请参阅:
    
    常量字段值
  - UNKNOWN_TON_VALUE
```
public static final int UNKNOWN_TON_VALUE
```
    Indicates an unknown number type. For details, see section 10.5.4.7 "Called party BCD number" in 3GPP TS 24.008.
    
    另请参阅:
    
    常量字段值
  - WAIT
```
public static final char WAIT
```
    'w' - Indicates the WAIT character defined in the ETSI GSM specifications.
    
    另请参阅:
    
    常量字段值
  - WILD
```
public static final char WILD
```
    'n' - Indicates the WILD character defined in the ETSI GSM specifications.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - TelephoneNumberUtils
```
public TelephoneNumberUtils()
```
- 方法详细资料
  - isDialTwelveKey
```
@Deprecated
public static boolean isDialTwelveKey(char input)
```
    已过时。
    
    Checks whether an input character is one of the 12 characters on the dialer, which are digits 0-9, the star key (*), and the pound key (#).
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is one of the 12 characters on the dialer; returns false otherwise.
  - isDialableDtmfKey
```
public static boolean isDialableDtmfKey(char input)
```
    Checks whether an input character is one of the 12 dialable DTMF keys on the dialer, which are digits 0-9, the star key (*), and the pound key (#).
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is one of the 12 dialable DTMF keys on the dialer; returns false otherwise.
  - isDialableKey
```
public static boolean isDialableKey(char input)
```
    Checks whether an input character is dialable, that is, a digit ranging from 0 to 9, the star key (*), the pound key (#), the plus sign (+), or WILD.
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is one of the characters listed; returns false otherwise.
  - isUriPhoneNumber
```
public static boolean isUriPhoneNumber(String phoneNumber)
```
    Checks whether a phone number contains '@' or '%40' to determine whether the phone number is a URI.
    
    参数:
    
    phoneNumber - Indicates the phone number to check.
    
    返回:
    
    Returns true if the phone number contains '@' or '%40'; returns false otherwise.
    
    从以下版本开始:
    
    3
  - isInternationalPhoneNumber
```
public static boolean isInternationalPhoneNumber(String phoneNumber)
```
    Checks whether a phone number is in the international number format.
    
    参数:
    
    phoneNumber - Indicates the phone number to check.
    
    返回:
    
    Returns true if the phone number is in the international number format; returns false otherwise.
  - isLatinDigit
```
public static boolean isLatinDigit(char input)
```
    Checks whether an input character is a latin digit ranging from 0 to 9.
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is a latin digit; returns false otherwise.
  - isNotSeparator
```
public static boolean isNotSeparator(char input)
```
    Checks whether an input character is a non-separator. Non-separators are digits ranging from 0 to 9, the star key (*), the pound key (#), the plus sign (+), WILD, WAIT, and PAUSE.
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is a non-separator; returns false otherwise.
  - isReallyDialableKey
```
public static boolean isReallyDialableKey(char input)
```
    Checks whether an input character is a digit ranging from 0 to 9, the star key (*), the pound key (#), or the plus sign (+).
    
    参数:
    
    input - Indicates the character to check.
    
    返回:
    
    Returns true if the character is one of the listed characters; returns false otherwise.
  - convertCalledPartyBCDToStringWithTOA
```
public static String convertCalledPartyBCDToStringWithTOA(byte[] data,
                                                          int offset,
                                                          int calledPartyBCDNumberLength,
                                                          int bcdExtendedType)
```
    Converts a called party binary-coded decimal (BCD) number carrying the TOA field.
    
    参数:
    
    data - Indicates the called party BCD number to convert.
    
    offset - Indicates the start position of the TOA field in the called party BCD number.
    
    calledPartyBCDNumberLength - Indicates the length of the called party BCD number.
    
    bcdExtendedType - Indicates the extended type of the called party BCD number.
    
    返回:
    
    Returns a called number of the string type.
  - convertCalledPartyBCDToStringWithoutTOA
```
public static String convertCalledPartyBCDToStringWithoutTOA(byte[] data,
                                                             int offset,
                                                             int calledPartyBCDNumberLength,
                                                             int bcdExtendedType)
```
    Converts a called party BCD number without the TOA field.
    
    参数:
    
    data - Indicates the called party BCD number to convert.
    
    offset - Indicates the start position of the called party BCD number.
    
    calledPartyBCDNumberLength - Indicates the length of the called party BCD number.
    
    bcdExtendedType - Indicates the extended type of the called party BCD number.
    
    返回:
    
    Returns a called number of the string type.
  - isEmergencyPhoneNumber
```
public static boolean isEmergencyPhoneNumber(String phoneNumber)
```
    Checks whether a phone number is on the emergency number list.
    
    参数:
    
    phoneNumber - Indicates the phone number to check.
    
    返回:
    
    Returns true if the phone number is on the emergency number list; returns false otherwise.
  - isLocalEmergencyPhoneNumber
```
public static boolean isLocalEmergencyPhoneNumber(String phoneNumber)
```
    Checks whether a phone number is an emergency number of the country where the calling party is located.
    
    参数:
    
    phoneNumber - Indicates the phone number to check.
    
    返回:
    
    Returns true if the phone number is an emergency number of the country where the calling party is located; returns false otherwise.
  - formatPhoneNumber
```
public static String formatPhoneNumber(String phoneNumber)
```
    Formats a phone number according to the Chinese Telephone Code Plan. Before the formatting, a phone number is in the format of country code (if any) + 3-digit service provider code + 4-digit area code + 4-digit subscriber number. After the formatting, each part is separated by a space.
    
    参数:
    
    phoneNumber - Indicates the phone number to format.
    
    返回:
    
    Returns the phone number after being formatted; returns an empty string if the input phone number is invalid.
  - formatPhoneNumber
```
public static String formatPhoneNumber(String phoneNumber,
                                       String defaultCountryCode)
```
    Formats a phone number.
    If a phone number does not contain the country or region code, the system formats the phone number according to the transferred country or region code.
    
    参数:
    
    phoneNumber - Indicates the phone number to format.
    
    defaultCountryCode - Indicates a two-digit country code defined in ISO 3166-1.
    
    返回:
    
    Returns the phone number after being formatted; returns an empty string if the input phone number is invalid.
  - formatPhoneNumber
```
public static String formatPhoneNumber(String phoneNumber,
                                       String phoneNumberE164,
                                       String defaultCountryCode)
```
    Formats a phone number according to the country code.
    All the characters in a phone number must be dialable.
    
    参数:
    
    phoneNumber - Indicates the phone number to format.
    
    phoneNumberE164 - Indicates an E.164 number. If the phone number does not contain a country code, the system formats the phone number according to phoneNumberE164.
    
    defaultCountryCode - Indicates a two-digit country code defined in ISO 3166-1. If phoneNumberE164 is null or invalid, or if the phone number is used for a call using international direct dialing (IDD), the system formats the phone number according to defaultCountryCode.
    
    返回:
    
    Returns the phone number after being formatted; returns an empty string if the input phone number is invalid.
  - formatPhoneNumberToE164
```
public static String formatPhoneNumberToE164(String phoneNumber,
                                             String defaultCountryCode)
```
    Formats a phone number into an E.164 representation.
    
    参数:
    
    phoneNumber - Indicates the phone number to format.
    
    defaultCountryCode - Indicates a two-digit country code defined in ISO 3166-1.
    
    返回:
    
    Returns an E.164 number; returns an empty string if the input phone number is invalid.
  - isVoiceMailNumber
```
public static boolean isVoiceMailNumber(String phoneNumber,
                                        int slotId)
```
    Checks whether a phone number is on the voice mailbox number list provided by the SIM card.
    Applications must have the ohos.permission.GET_TELEPHONY_STATE permission to call this method.
    
    参数:
    
    phoneNumber - Indicates the phone number to check.
    
    slotId - Indicates the ID of a SIM card slot.
    
    返回:
    
    Returns true if the phone number is on the voice mailbox number list; returns false otherwise.
  - removeSeparators
```
public static String removeSeparators(String phoneNumber)
```
    Removes separators from a phone number.
    
    参数:
    
    phoneNumber - Indicates the phone number for which the separators are to be removed.
    
    返回:
    
    Returns a phone number without separators; returns an empty string if the input phone number is invalid.
  - isSuitableSmsAddress
```
public static boolean isSuitableSmsAddress(String address)
```
    Checks whether the network address of the Short Message Service (SMS) can be used as the destination address.
    
    参数:
    
    address - Indicates the SMS address to check.
    
    返回:
    
    Returns true if the SMS address can be used as the destination address; returns false otherwise.
  - normalizePhoneNumber
```
public static String normalizePhoneNumber(String phoneNumber)
```
    Normalizes a phone number by deleting characters other than digits. If a phone number contains alphabetic letters, they are converted to digits.
    
    参数:
    
    phoneNumber - Indicates the phone number to normalize.
    
    返回:
    
    Returns a normalized phone number.
  - comparePhoneNumbers
```
public static boolean comparePhoneNumbers(String phoneNumberA,
                                          String phoneNumberB)
```
    Compares two phone numbers.
    This method uses loose comparison, which compares only digits and international prefixes or non-Russian trunk prefixes from right to left to see whether the two phone numbers are identical.
    
    参数:
    
    phoneNumberA - Indicates the first phone number.
    
    phoneNumberB - Indicates the second phone number.
    
    返回:
    
    Returns true if the two phone numbers are identical; returns false otherwise.
  - changeKeypadLettersToDigits
```
public static String changeKeypadLettersToDigits(String data)
```
    Converts any alphabetic letter ([A-Z] or [a-z]) in a phone number to an equivalent digit according to the phone keyboard mapping described in ITU E.161 and ISO/IEC 9995-8.
    
    参数:
    
    data - Indicates a phone number that may contain letters, for example, 1-887-ADqV-211.
    
    返回:
    
    Returns a data string after being converted, for example, 1-887-2378-211.
  - extractNetworkAddressPortion
```
public static String extractNetworkAddressPortion(String phoneNumber)
```
    Extracts the network address and standardizes it by filtering out separators.
    
    参数:
    
    phoneNumber - Indicates the phone number to extract.
    
    返回:
    
    Returns a network address after being extracted and normalized, which contains only dialable characters.
  - extractNetworkAddressPortionPlus
```
public static String extractNetworkAddressPortionPlus(String phoneNumber)
```
    Extracts the network address from a phone number and standardizes it by filtering out separators (excluding the plus sign (+), if available).
    
    参数:
    
    phoneNumber - Indicates the phone number to process.
    
    返回:
    
    Returns the processed network address; returns an empty string if the input phone number is null or a zero-length string.
    
    从以下版本开始:
    
    3
  - extractPostDialPortion
```
public static String extractPostDialPortion(String phoneNumber)
```
    Obtains the dual-tone multifrequency (DTMF) control bit, pause character, and wait character from a phone number.
    
    参数:
    
    phoneNumber - Indicates the phone number to process.
    
    返回:
    
    Returns the string that consists of the DTMF control bit, pause character, and wait character; returns an empty string if the input phone number is null or a zero-length string.
    
    从以下版本开始:
    
    3
  - convertPhoneNumber
```
public static String convertPhoneNumber(String phoneNumber)
```
    Converts the character 'p' or 'P' in a phone number to a comma (,), and the character "w" or "W" to a semicolon (;).
    
    参数:
    
    phoneNumber - Indicates the phone number to process.
    
    返回:
    
    Returns the processed phone number; returns an empty string if the input phone number is null or a zero-length string.
    
    从以下版本开始:
    
    3
  - getCountryIsoFromDbNumber
```
public static String getCountryIsoFromDbNumber(String phoneNumber)
```
    Obtains the ISO country code of a phone number from the database.
    
    参数:
    
    phoneNumber - Indicates the phone number to query.
    
    返回:
    
    Returns the ISO country code obtained from the database.
    
    从以下版本开始:
    
    3
  - getIntlPrefixAndCCLen
```
public static int getIntlPrefixAndCCLen(String phoneNumber)
```
    Obtains the prefix length of a specified phone number.
    
    参数:
    
    phoneNumber - Indicates the specified phone number.
    
    返回:
    
    Returns the prefix length.
    
    从以下版本开始:
    
    5
  - replacePauseAndWaitChar
```
public static String replacePauseAndWaitChar(String phoneNumber)
```
    Replaces pause characters with semicolons and waiting characters with commas in a specified phone number.
    
    参数:
    
    phoneNumber - Indicates the phone number holding the characters to replace.
    
    返回:
    
    Returns the phone number after character replacement.
    
    从以下版本开始:
    
    5
  - isWaitOrPauseChar
```
public static boolean isWaitOrPauseChar(char c)
```
    Checks whether a character is a wait or pause character.
    
    参数:
    
    c - Indicates the character to check.
    
    返回:
    
    Returns true if the character is a wait or pause character; returns false otherwise.
    
    从以下版本开始:
    
    5

类 TelephoneNumberUtils

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

BCD_EXT_TYPE_CALLED_PARTY

BCD_EXT_TYPE_EF_ADN

INTERNATIONAL_TON_VALUE

PAUSE

UNKNOWN_TON_VALUE

WAIT

WILD

构造器详细资料

TelephoneNumberUtils

方法详细资料

isDialTwelveKey

isDialableDtmfKey

isDialableKey

isUriPhoneNumber

isInternationalPhoneNumber

isLatinDigit

isNotSeparator

isReallyDialableKey

convertCalledPartyBCDToStringWithTOA

convertCalledPartyBCDToStringWithoutTOA

isEmergencyPhoneNumber

isLocalEmergencyPhoneNumber

formatPhoneNumber

formatPhoneNumber

formatPhoneNumber

formatPhoneNumberToE164

isVoiceMailNumber

removeSeparators

isSuitableSmsAddress

normalizePhoneNumber

comparePhoneNumbers

changeKeypadLettersToDigits

extractNetworkAddressPortion

extractNetworkAddressPortionPlus

extractPostDialPortion

convertPhoneNumber

getCountryIsoFromDbNumber

getIntlPrefixAndCCLen

replacePauseAndWaitChar

isWaitOrPauseChar