Person
class Person
Provides an immutable reference to an entity that appears repeatedly on different surfaces of the platform. For example, this could represent the sender of a message.
Summary
Nested types |
|---|
class Person.BuilderBuilder for the immutable |
Public functions |
|
|---|---|
Boolean |
|
java-static Person |
fromBundle(bundle: Bundle)Extracts and returns the |
IconCompat? |
getIcon()Returns the icon for this |
String? |
getKey()Returns the key for this |
CharSequence? |
getName()Returns the name for this |
String? |
getUri()Returns the raw URI for this |
Int |
hashCode() |
Boolean |
isBot()Returns whether or not this |
Boolean |
Returns whether or not this |
Person.Builder |
Creates and returns a new |
Bundle |
toBundle()Writes and returns a new |
Public functions
fromBundle
java-static fun fromBundle(bundle: Bundle): Person
Extracts and returns the Person written to the bundle. A bundle can be created from a Person using toBundle.
getIcon
fun getIcon(): IconCompat?
Returns the icon for this Person or null if no icon was provided.
getKey
fun getKey(): String?
Returns the key for this Person or null if no key was provided. This is provided as a unique identifier between other Persons.
getName
fun getName(): CharSequence?
Returns the name for this Person or null if no name was provided. This could be a full name, nickname, username, etc.
getUri
fun getUri(): String?
Returns the raw URI for this Person or null if no URI was provided. A URI can be any of the following:
- The
Stringrepresentation of aCONTENT_LOOKUP_URI - A
mailto:schema* - A
tel:schema*
*Note for these schemas, the path portion of the URI must exist in the contacts database in their appropriate column, otherwise the reference should be discarded.
isBot
fun isBot(): Boolean
Returns whether or not this Person is a machine rather than a human. Used primarily to identify automated tooling.
isImportant
fun isImportant(): Boolean
Returns whether or not this Person is important to the user of this device with regards to how frequently they interact.
toBuilder
fun toBuilder(): Person.Builder
Creates and returns a new Builder initialized with this Person's data.