Person.Builder
class Person.Builder
Builder for the immutable Person class.
Summary
Public functions |
|
|---|---|
Person |
build()Creates and returns the |
Person.Builder |
Sets whether or not this |
Person.Builder |
setIcon(icon: IconCompat?)Set an icon for this |
Person.Builder |
setImportant(important: Boolean)Sets whether this is an important person. |
Person.Builder |
Set a unique identifier for this |
Person.Builder |
setName(name: CharSequence?)Give this |
Person.Builder |
Set a URI for this |
Public functions
setBot
fun setBot(bot: Boolean): Person.Builder
Sets whether or not this Person represents a machine rather than a human. This is used primarily for testing and automated tooling.
setIcon
fun setIcon(icon: IconCompat?): Person.Builder
Set an icon for this Person.
The system will prefer this icon over any images that are resolved from setUri.
setImportant
fun setImportant(important: Boolean): Person.Builder
Sets whether this is an important person. Use this method to denote users who frequently interact with the user of this device when setUri isn't provided with CONTENT_LOOKUP_URI, and instead with the mailto: or tel: schemas.
setKey
fun setKey(key: String?): Person.Builder
Set a unique identifier for this Person. This is especially useful if the setName value isn't unique. This value is preferred for identification, but if it's not provided, the person's name will be used in its place.
setName
fun setName(name: CharSequence?): Person.Builder
Give this Person a name to use for display. This can be, for example, a full name, nickname, username, etc.
setUri
fun setUri(uri: String?): Person.Builder
Set a URI for this Person which 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 will be discarded.