Safe Haskell	None
Language	Haskell98

Data.PhoneNumber

Contents

Types
Parsing
PhoneNumberRef accessors/utilities
Utility

Synopsis

Types

data PhoneNumber Source

A data type representation of a phone number, you can build one of these with copyPhoneNumberRef.

Constructors

PhoneNumber
Fields countryCode :: Maybe Word64 nationalNumber :: Maybe Word64 extension :: Maybe ByteString

Instances

Eq PhoneNumber Source
Show PhoneNumber Source

data PhoneNumberRef Source

An opaque pointer to a PhoneNumberRef C++ class

Instances

Show PhoneNumberRef Source

data PhoneNumberType Source

Instances

Enum PhoneNumberType Source
Eq PhoneNumberType Source
Show PhoneNumberType Source

data PhoneNumberParseError Source

There was a problem parting your phone number. For now, if you want to know what the Int here means, you'll need to look at the ErrorType enum in the underlying library.

Constructors

PhoneNumberParseError Int

Instances

Eq PhoneNumberParseError Source
Show PhoneNumberParseError Source

Parsing

parsePhoneNumber Source

Arguments

:: ByteString	The phone number to parse
-> ByteString	A two letter country code for the default region to be assumed
-> Either PhoneNumberParseError PhoneNumber

Try to parse a phone number, building a PhoneNumber including commonly accessed information.

This is marginally more expensive than parsing a PhoneNumberRef with parsePhoneNumberRef and extracting just the fields that you need, although the latter will allow you to retrieve more information such as the type of number (which requires more underlying library calls).

parsePhoneNumberRef Source

Arguments

:: ByteString	The phone number to parse
-> ByteString	A two letter country code for the default region to be assumed
-> Either PhoneNumberParseError PhoneNumberRef

Try to parse a PhoneNumberRef, see the PhoneNumberRef accessors/utilities section below for useful things to do with the result.

PhoneNumberRef accessors/utilities

refCountryCode :: PhoneNumberRef -> Maybe Word64 Source

refNationalNumber :: PhoneNumberRef -> Maybe Word64 Source

refExtension :: PhoneNumberRef -> Maybe ByteString Source

refType :: PhoneNumberRef -> PhoneNumberType Source

Utility

convertAlphaCharacters :: ByteString -> ByteString Source

Convert any alpha characters in a phone number to their equivalent keypad numbers.