kotose-form-phone/io.github.robinpcrd.kotose.form.utils/PhoneNumberBackend

PhoneNumberBackend

@SubclassOptInRequired(markerClass = [ExperimentalKotoseFormApi::class])

Phone number metadata for phone fields: dial codes, parsing, validation and formatting.

Without a current backend, phone fields take a typed dial code and a number, and IsValidPhoneRule only checks that a dial code is present. The kotose-form-phone-backend module provides LibPhoneNumberBackend.

Types

Companion

object Companion

Functions

countryCode

abstract fun countryCode(region: String): Int

The dial code of region, or 0 when it has none.

formatPartial

abstract fun formatPartial(number: String, region: String): String

The national number formatted as the user types it.

isPossibleNumber

abstract fun isPossibleNumber(number: String, region: String): Boolean

parse

abstract fun parse(phone: String, defaultRegion: String): PhoneParseResult?

A national or international number, or null when it cannot be parsed.

parsePartial

abstract fun parsePartial(phone: String, defaultRegion: String): PhonePartialResult?

An international number typed so far, from its dial code on, or null.