Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 3.73 KB

README.md

File metadata and controls

116 lines (78 loc) · 3.73 KB
Raw

PhoneNumberValidator

To help implement phone number validation before performing any further operation. Convert phone number to phone number with country code and also remove country code from a phone number and automatically get the country of a user. This library helps make sure the number is valid for the selected country.

Download Android Arsenal License

Adding to your project.

compile 'xyz.belvi.validator:phonenumbervalidator:1.0.0'

Samples

See sample application in project for a brief walk through on how to use the library.

Snippet.

PhoneNumberVerifier numberVerifier = new PhoneNumberVerifier();

Countries can be gotten by:

  • automatically getting the user country
numberVerifier.getUserCountry()

this returns the users country or null if nothing is found

  • get user country by mc (mobile country code).

This is unique for all country

numberVerifier.getCountryByMnc(621)

to get mcc in android:

TelephonyManager telephonyManager = (TelephonyManager)context.getSystemService(Context.TELEPHONY_SERVICE);
String simOperator = telephonyManager.getSimOperator();
if (!simOperator.isEmpty()) {
int mcc = Integer.parseInt(String.valueOf(context.getResources().getConfiguration().mcc));
}
  • phone number

get the country by passing a phone number to the method. This returns a country that allows the phone number format. The phone number should have a country code else, this method would return the default country passed to it.

numberVerifier.getCountryByPhoneNumber(Countries.CANADA, "2348123456789")
  • by name

returns country by name. Pass a string name of the coutry to get the country

numberVerifier.getCountryByName("Nigeria")
  • by country code

this returns a list of country as some country shares same country code.

numberVerifier.getCountriesByCountryCode(234)
  • direct initialisation

calling the country by its value type;

Countries country = PhoneNumberVerifier.Countries.Nigeria;

#Using the PhoneModel Class To check if a number is valid for a country, use the phoneModel class.

PhoneModel model = country.isNumberValid("08012345678");

model.isNumberValid() tells if the number is valid or not. If it is valid, you can basically a better formatted version of the number from model.getPhoneNumber(). This is empty when model.isNumberValid() is false;

#Converting Numbers Numbers can be converted to plain number from countrycode number and converted to plain number from counrtycode number (i.e) from 080231**** to +23481231**** or from +23481231**** to 080231****

use country.toPlainNumber(phonenumber) and country.toCountryCodeNumber(phonenumber) to achieve this

#Handling Exception Watch out for the PhoneFormatException. It is thrown when phone contains invalid characters mainly.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.