Added in API level Baklava

ParsedPhoneNumber

---

Kotlin |Java

class ParsedPhoneNumber : Parcelable

kotlin.Any
↳	android.telephony.ParsedPhoneNumber

Handles the results from PhoneNumberManager by providing Phone number, error code, and is valid number.

Summary

Constants
static Int	ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER The phone number failed to be validated.
static Int	ERROR_TYPE_NONE No error seen.
static Int	ERROR_TYPE_NUMBER_PARSE_EXCEPTION There was an error when trying to extract the phone number.
static Int	ERROR_TYPE_UNKNOWN Failed to extract phone number for unknown reason.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
ParsedPhoneNumber(phoneNumber: String, errorCode: Int, isValidPhoneNumber: Boolean)

Public methods
Int	describeContents()
Boolean	equals(other: Any?)
Int	getErrorCode() If no phone number was able to be extracted this will report the failure reason to the user.
String	getParsedPhoneNumber() Parsed phone number.
Int	hashCode()
Boolean	isValidPhoneNumber() Whether or not we were able to extract a valid phone number
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ParsedPhoneNumber!>	CREATOR

Constants

ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER

Added in API level Baklava

static val ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER: Int

The phone number failed to be validated.

Value: 1

ERROR_TYPE_NONE

Added in API level Baklava

static val ERROR_TYPE_NONE: Int

No error seen.

Value: 0

ERROR_TYPE_NUMBER_PARSE_EXCEPTION

Added in API level Baklava

static val ERROR_TYPE_NUMBER_PARSE_EXCEPTION: Int

There was an error when trying to extract the phone number.

Value: 2

ERROR_TYPE_UNKNOWN

Added in API level Baklava

static val ERROR_TYPE_UNKNOWN: Int

Failed to extract phone number for unknown reason.

Value: -1

Public constructors

ParsedPhoneNumber

Added in API level Baklava

ParsedPhoneNumber(
    phoneNumber: String, 
    errorCode: Int, 
    isValidPhoneNumber: Boolean)

Parameters
phoneNumber	String: the phone number extracted. Empty if we weren't successful in parsing. This value cannot be null.
errorCode	Int: ErrorType seen when trying to extract phone number. Value is android.telephony.ParsedPhoneNumber#ERROR_TYPE_UNKNOWN, android.telephony.ParsedPhoneNumber#ERROR_TYPE_NONE, android.telephony.ParsedPhoneNumber#ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER, or android.telephony.ParsedPhoneNumber#ERROR_TYPE_NUMBER_PARSE_EXCEPTION
isValidPhoneNumber	Boolean: whether or not we succeeded in retrieving the number.

Public methods

describeContents

Added in API level Baklava

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level Baklava

fun equals(other: Any?): Boolean

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getErrorCode

Added in API level Baklava

fun getErrorCode(): Int

If no phone number was able to be extracted this will report the failure reason to the user.

Return
Int	Value is android.telephony.ParsedPhoneNumber#ERROR_TYPE_UNKNOWN, android.telephony.ParsedPhoneNumber#ERROR_TYPE_NONE, android.telephony.ParsedPhoneNumber#ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER, or android.telephony.ParsedPhoneNumber#ERROR_TYPE_NUMBER_PARSE_EXCEPTION

getParsedPhoneNumber

Added in API level Baklava

fun getParsedPhoneNumber(): String

Parsed phone number.

Return
String	This value cannot be null.

Exceptions
java.lang.IllegalStateException	if isValidPhoneNumber is false.

hashCode

Added in API level Baklava

fun hashCode(): Int

Return
Int	a hash code value for this object.

isValidPhoneNumber

Added in API level Baklava

fun isValidPhoneNumber(): Boolean

Whether or not we were able to extract a valid phone number

toString

Added in API level Baklava

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level Baklava

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava

static val CREATOR: Parcelable.Creator<ParsedPhoneNumber!>