public class PhoneNumberOfflineGeocoder
extends java.lang.Object
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getDescriptionForNumber(Phonenumber.PhoneNumber number,
java.util.Locale languageCode) |
As per
getDescriptionForValidNumber(PhoneNumber, Locale) but explicitly checks
the validity of the number passed in. |
java.lang.String |
getDescriptionForNumber(Phonenumber.PhoneNumber number,
java.util.Locale languageCode,
java.lang.String userRegion) |
As per
getDescriptionForValidNumber(PhoneNumber, Locale, String) but
explicitly checks the validity of the number passed in. |
java.lang.String |
getDescriptionForValidNumber(Phonenumber.PhoneNumber number,
java.util.Locale languageCode) |
Returns a text description for the given phone number, in the language provided.
|
java.lang.String |
getDescriptionForValidNumber(Phonenumber.PhoneNumber number,
java.util.Locale languageCode,
java.lang.String userRegion) |
As per
getDescriptionForValidNumber(PhoneNumber, Locale) but also considers the
region of the user. |
static PhoneNumberOfflineGeocoder |
getInstance() |
Gets a
PhoneNumberOfflineGeocoder instance to carry out international phone number
geocoding. |
public static PhoneNumberOfflineGeocoder getInstance()
PhoneNumberOfflineGeocoder
instance to carry out international phone number
geocoding.
The PhoneNumberOfflineGeocoder
is implemented as a singleton. Therefore, calling
this method multiple times will only result in one instance being created.
PhoneNumberOfflineGeocoder
instancepublic java.lang.String getDescriptionForValidNumber(Phonenumber.PhoneNumber number, java.util.Locale languageCode)
This method assumes the validity of the number passed in has already been checked, and that the number is suitable for geocoding. We consider fixed-line and mobile numbers possible candidates for geocoding.
number
- a valid phone number for which we want to get a text descriptionlanguageCode
- the language code for which the description should be writtenpublic java.lang.String getDescriptionForValidNumber(Phonenumber.PhoneNumber number, java.util.Locale languageCode, java.lang.String userRegion)
getDescriptionForValidNumber(PhoneNumber, Locale)
but also considers the
region of the user. If the phone number is from the same region as the user, only a lower-level
description will be returned, if one exists. Otherwise, the phone number's region will be
returned, with optionally some more detailed information.
For example, for a user from the region "US" (United States), we would show "Mountain View, CA" for a particular number, omitting the United States from the description. For a user from the United Kingdom (region "GB"), for the same number we may show "Mountain View, CA, United States" or even just "United States".
This method assumes the validity of the number passed in has already been checked.
number
- the phone number for which we want to get a text descriptionlanguageCode
- the language code for which the description should be writtenuserRegion
- the region code for a given user. This region will be omitted from the
description if the phone number comes from this region. It should be a two-letter
upper-case CLDR region code.public java.lang.String getDescriptionForNumber(Phonenumber.PhoneNumber number, java.util.Locale languageCode)
getDescriptionForValidNumber(PhoneNumber, Locale)
but explicitly checks
the validity of the number passed in.number
- the phone number for which we want to get a text descriptionlanguageCode
- the language code for which the description should be writtenpublic java.lang.String getDescriptionForNumber(Phonenumber.PhoneNumber number, java.util.Locale languageCode, java.lang.String userRegion)
getDescriptionForValidNumber(PhoneNumber, Locale, String)
but
explicitly checks the validity of the number passed in.number
- the phone number for which we want to get a text descriptionlanguageCode
- the language code for which the description should be writtenuserRegion
- the region code for a given user. This region will be omitted from the
description if the phone number comes from this region. It should be a two-letter
upper-case CLDR region code.Copyright © 2020 Google. All Rights Reserved.