ParsedPhoneNumber

ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER

static val ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER: Int

The phone number failed to be validated.

Value: 1

ERROR_TYPE_NONE

static val ERROR_TYPE_NONE: Int

No error seen.

Value: 0

ERROR_TYPE_NUMBER_PARSE_EXCEPTION

static val ERROR_TYPE_NUMBER_PARSE_EXCEPTION: Int

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

Value: 2

ERROR_TYPE_UNKNOWN

static val ERROR_TYPE_UNKNOWN: Int

Failed to extract phone number for unknown reason.

Value: -1

ParsedPhoneNumber

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

describeContents

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getErrorCode

fun getErrorCode(): Int

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

getParsedPhoneNumber

fun getParsedPhoneNumber(): String

Parsed phone number.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isValidPhoneNumber

fun isValidPhoneNumber(): Boolean

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

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<ParsedPhoneNumber!>