affogato-structure/com.parsuomash.affogato.structure.validation/Phone/format

format

@JvmOverloads

fun format(defaultRegion: String? = null, numberFormat: PhoneNumberFormat = INTERNATIONAL): String?

Formats a phone number in the specified format using default rules.

Since

1.4.0

Return

the formatted phone number.

Parameters

defaultRegion

region that we are expecting the number to be from. This is only used if the number being parsed is not written in international format. The country_code for the number in this case would be stored as that of the default region supplied. If the number is guaranteed to start with a '+' followed by the country calling code, then RegionCode. ZZ or null can be supplied.

numberFormat

the format the phone number should be formatted into. default value is INTERNATIONAL