ParsedPhoneNumber
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 |
The phone number failed to be validated. |
| static Int |
No error seen. |
| static Int |
There was an error when trying to extract the phone number. |
| static Int |
Failed to extract phone number for unknown reason. |
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
ParsedPhoneNumber(phoneNumber: String, errorCode: Int, isValidPhoneNumber: Boolean) |
|
| Public methods | |
|---|---|
| Int | |
| Boolean | |
| Int |
If no phone number was able to be extracted this will report the failure reason to the user. |
| String |
Parsed phone number. |
| Int |
hashCode() |
| Boolean |
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!> | |
Constants
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: 1ERROR_TYPE_NUMBER_PARSE_EXCEPTION
static val ERROR_TYPE_NUMBER_PARSE_EXCEPTION: Int
There was an error when trying to extract the phone number.
Value: 2ERROR_TYPE_UNKNOWN
static val ERROR_TYPE_UNKNOWN: Int
Failed to extract phone number for unknown reason.
Value: -1Public constructors
ParsedPhoneNumber
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
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
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
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.
| Return | |
|---|---|
String |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if isValidPhoneNumber is false. |
isValidPhoneNumber
fun isValidPhoneNumber(): Boolean
Whether or not we were able to extract a valid phone number
toString
fun toString(): String
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 |