Skip to content

Enrichment

Enrichment uses offline bundled metadata. The first call in a transaction may load static resources; avoid tight loops on very hot paths without caching.

NF.carrierNameForValidNumber

Carrier name for a valid number.

Signatures

global static String carrierNameForValidNumber(NF.Phone phone, String localeTag)

Parameters

NameTypeDescription
phoneNF.PhoneValid parsed number.
localeTagStringBCP 47 language tag (e.g. en, it).

Returns

Carrier name, or empty string if unknown.

Throws

None.

libphonenumber

PhoneNumberToCarrierMapper.getNameForValidNumber(PhoneNumber, String)

Example

NF.Phone phone = NF.parse('+244 917 654 321', 'AO');
String carrier = NF.carrierNameForValidNumber(phone, 'en');

NF.carrierNameForNumber

Carrier name without requiring prior validity check.

Signatures

global static String carrierNameForNumber(NF.Phone phone, String localeTag)

Parameters

Returns

Carrier name or empty string.

Throws

None.

libphonenumber

PhoneNumberToCarrierMapper.getNameForNumber(PhoneNumber, String)

Example

String carrier = NF.carrierNameForNumber(phone, 'en');

NF.safeCarrierName

Carrier name safe for display (never null).

Signatures

global static String safeCarrierName(NF.Phone phone, String localeTag)

Parameters

Returns

Display-safe carrier string.

Throws

None.

libphonenumber

PhoneNumberToCarrierMapper.getSafeDisplayName(PhoneNumber, String)

Example

String label = NF.safeCarrierName(phone, 'en');

NF.descriptionForValidNumber

Geographic description for a valid number (city/region or country).

Signatures

global static String descriptionForValidNumber(NF.Phone phone, String localeTag)

Description in the requested language.

global static String descriptionForValidNumber(NF.Phone phone, String localeTag, String userRegion)

Same, but phrased for a viewer in userRegion (e.g. show country name when the number is abroad).

Parameters

Parameters depend on the signature; see Signatures above.

NameTypeDescription
phoneNF.PhoneValid parsed number.
localeTagStringLanguage for the description.
userRegionStringViewer’s region (three-argument overload).

Returns

Human-readable place name (offline geocoder).

Throws

None.

libphonenumber

PhoneNumberOfflineGeocoder.getDescriptionForValidNumber(…)

Example

NF.Phone phone = NF.parse('+1 650-253-0000', 'US');
String place = NF.descriptionForValidNumber(phone, 'en_US');
// place → "Mountain View, CA"
String forItalianViewer = NF.descriptionForValidNumber(phone, 'it', 'IT');
// country/region label for an Italian user

NF.descriptionForNumber

Geographic description without requiring validity.

Signatures

global static String descriptionForNumber(NF.Phone phone, String localeTag)

Two-argument form.

global static String descriptionForNumber(NF.Phone phone, String localeTag, String userRegion)

Three-argument form with viewer region for disambiguation.

Parameters

Returns

Description string.

Throws

None.

libphonenumber

PhoneNumberOfflineGeocoder.getDescriptionForNumber(…)

Example

String place = NF.descriptionForNumber(phone, 'es_ES', 'IT');
// e.g. country name in Spanish for an Italian viewer

NF.timeZonesForGeographicalNumber

IANA time zones for a geographical number.

Signatures

global static List<String> timeZonesForGeographicalNumber(NF.Phone phone)

Parameters

NameTypeDescription
phoneNF.PhoneParsed geographical number.

Returns

List<String> of time zone IDs (e.g. America/Los_Angeles).

Throws

None.

libphonenumber

PhoneNumberToTimeZonesMapper.getTimeZonesForGeographicalNumber(PhoneNumber)

Example

List<String> tz = NF.timeZonesForGeographicalNumber(phone);

NF.timeZonesForNumber

Time zones for any number type (geographical or mobile).

Signatures

global static List<String> timeZonesForNumber(NF.Phone phone)

Parameters

NameTypeDescription
phoneNF.PhoneParsed number.

Returns

List of IANA time zone IDs.

Throws

None.

libphonenumber

PhoneNumberToTimeZonesMapper.getTimeZonesForNumber(PhoneNumber)

Example

List<String> tz = NF.timeZonesForNumber(phone);

NF.unknownTimeZone

Constant returned when no time zone is known.

Signatures

global static String unknownTimeZone()

Parameters

None.

Returns

Etc/Unknown

Throws

None.

libphonenumber

PhoneNumberToTimeZonesMapper.getUnknownTimeZone()

Example

String unknown = NF.unknownTimeZone(); // "Etc/Unknown"