Person.Builder

Added in 1.1.0

class Person.Builder


Builder for the immutable Person class.

Summary

Public constructors

Creates a new, empty Builder.

Public functions

Person

Creates and returns the Person this builder represents.

Person.Builder

Sets whether or not this Person represents a machine rather than a human.

Person.Builder

Set an icon for this Person.

Person.Builder
setImportant(important: Boolean)

Sets whether this is an important person.

Person.Builder
setKey(key: String?)

Set a unique identifier for this Person.

Person.Builder

Give this Person a name to use for display.

Person.Builder
setUri(uri: String?)

Set a URI for this Person which can be any of the following:

Public constructors

Builder

Added in 1.1.0
Builder()

Creates a new, empty Builder.

Public functions

build

Added in 1.1.0
fun build(): Person

Creates and returns the Person this builder represents.

setBot

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
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

Added in 1.1.0
fun setUri(uri: String?): Person.Builder

Set a URI for this Person which can be any of the following:

*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.