Class TulPhoneNumberUtils

class TulPhoneNumberUtils;

Description

Class offers static methods for parsing and validating phone numbers. Phone Parser API provides methods which are used to parse and validate phone numbers. The API consists of the TulPhoneNumberUtils class.

Examples of valid phone numbers: 1. +358501234567 2. +358 (50) 123 4567

Even though both of the above examples are valid phone numbers, only 1) is accepted as a phone number by many systems. To convert 2) to 1), use the parsing method of the API.

Usage:

 #include <tulphonenumberutils.h> 

 // Example shows how to use the parsing method of the API.

 // A number to be parsed. 
 TBuf<50> number1 = _L("+358 (40) 123 132");

 // Type of the phone number to be parsed is a regular phone number.
 TBool validNumber1 = 
 TulPhoneNumberUtils::NormalizePhoneNumber( number1,
                                      TulPhoneNumberUtils::EPlainPhoneNumber );

 // The phone number number1 is a valid regular phone number.
 // After parsing validNumber1 is ETrue and 
 // number1 is "+35840123132".
 // Do something like SendSMS( number1 ) etc.

 // A number to be parsed. 
 TBuf<50> number2 = _L("+358 (40) 123p132"); // note 'p'

 // Type of the phone number to be parsed is a regular phone number.
 TBool validNumber2 = 
 TulPhoneNumberUtils::NormalizePhoneNumber( number2,
                                      TulPhoneNumberUtils::EPlainPhoneNumber );

 // The phone number number2 is not a valid regular phone number.
 // After parsing validNumber2 is EFalse and 
 // number2 is "+358 (40) 123p132" (unchanged).

Members

Defined in TulPhoneNumberUtils:

• EContactCardNumberThe supplied phone number is a contact card number.
• EPhoneClientNumberThe supplied phone number is is a phone client number.
• EPlainPhoneNumberThe supplied phone number is a regular phone number.
• ESMSNumberThe supplied phone number is an SMS number.
• IsValid(const TDesC &,TPhoneNumberType)
• IsValidPhoneNumber(const TDesC &,TInt)
• Normalize(TDes &,TPhoneNumberType)
• ParsePhoneNumber(TDes &,TInt)
• TPhoneNumberTypeEnumeration for phone number types. Used to specify the type of phone numbers in...

IMPORT_C static TBool Normalize(TDes &aNumber, TPhoneNumberType aType=EPlainPhoneNumber);

Description

Parameters

TDes16 &aNumber TulPhoneNumberUtils::TPhoneNumberType aType

Return value

TBool

IMPORT_C static TBool IsValid(const TDesC &aNumber, TPhoneNumberType aType=EPlainPhoneNumber);

Description

Parameters

const TDesC16 &aNumber TulPhoneNumberUtils::TPhoneNumberType aType

Return value

TBool

Interface status:

deprecated

static inline TBool ParsePhoneNumber(TDes &aNumber, TInt aType);

Description

Parameters

TDes16 &aNumber TInt aType

Return value

TBool

Interface status:

deprecated

static inline TBool IsValidPhoneNumber(const TDesC &aNumber, TInt aType);

Description

Parameters

const TDesC16 &aNumber TInt aType

Return value

TBool

TPhoneNumberType

Description

Enumeration for phone number types. Used to specify the type of phone numbers in methods of TulPhoneNumberUtils class.

EPlainPhoneNumber The supplied phone number is a regular phone number. EContactCardNumber The supplied phone number is a contact card number. EPhoneClientNumber The supplied phone number is is a phone client number. ESMSNumber The supplied phone number is an SMS number.