CommonPhoneParser Class Reference

API published in: S60 2nd Ed

Link against: commonengine.lib

Capability Information

Required Capabilities

None

#include <commonphoneparser.h>

Detailed 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 consist of the CommonPhoneParser 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 <commonphoneparser.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 = 
  CommonPhoneParser::ParsePhoneNumber( number1,
                                       CommonPhoneParser::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 = 
  CommonPhoneParser::ParsePhoneNumber( number2,
                                       CommonPhoneParser::EPlainPhoneNumber );

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

Public Types
enum   TPhoneNumberType { EPlainPhoneNumber, EContactCardNumber, EPhoneClientNumber, ESMSNumber }
  Enumeration for phone number types. More...

Static Public Member Functions
static IMPORT_C TBool  ParsePhoneNumber (TDes &aNumber, TPhoneNumberType aType)
  Parses the supplied phone number.
static IMPORT_C TBool  IsValidPhoneNumber (const TDesC &aNumber, TPhoneNumberType aType)
  Checks if string is a valid phone number.
static TBool  IsValidPhoneNumber (const TDesC &aNumber, const TDesC &aValidChars)
  This method is meant for internal use of Phone Parser.
static void  ParseInvalidChars (TDes &aNumber, const TDesC &aInvalidChars)
  This method is meant for internal use of Phone Parser.

Member Enumeration Documentation

enum CommonPhoneParser::TPhoneNumberType
 

Enumeration for phone number types.

Used to specify the type of phone numbers in methods of CommonPhoneParser class.

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

Member Function Documentation

static TBool CommonPhoneParser::IsValidPhoneNumber (  const TDesC &  aNumber,
const TDesC &  aValidChars
)  [static]
 

This method is meant for internal use of Phone Parser.

Check if string is a valid phone number

Parameters:
aNumber  Number which will be checked
aValidChars  Characters that are valid for the number. Note! Some chars have special rules. See Find Item UI specification for more info.
Returns:
ETrue if the number was valid, otherwise EFalse.
static IMPORT_C TBool CommonPhoneParser::IsValidPhoneNumber (  const TDesC &  aNumber,
TPhoneNumberType  aType
)  [static]
 

Checks if string is a valid phone number.

This method checks if the supplied phone number is a valid phone number of the supplied type.

Parameters:
aNumber  which validity will be checked.
aType  is the type of the supplied phone number.
Returns:
ETrue if the supplied phone number is a valid number of the supplied type. Otherwise EFalse.
static void CommonPhoneParser::ParseInvalidChars (  TDes &  aNumber,
const TDesC &  aInvalidChars
)  [static]
 

This method is meant for internal use of Phone Parser.

Parses invalid characters from a string

Parameters:
aNumber  Number which will be parsed.
aInvalidChars  Characters that are invalid.
static IMPORT_C TBool CommonPhoneParser::ParsePhoneNumber (  TDes &  aNumber,
TPhoneNumberType  aType
)  [static]
 

Parses the supplied phone number.

This method removes irrelevant characters and white spaces from the supplied phone number. Allowed characters are determined by phone number type.

Parameters:
aNumber  will be checked and parsed. After returning contains the parsed number if the supplied phone number was a valid phone number. If the number was not valid no parsing will be done.
aType  is the type of the supplied phone number.
Returns:
ETrue if the supplied phone number is a valid number of the supplied type and the parsing succeeds. Otherwise EFalse.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top