Person.Builder

Added in 1.1.0

Kotlin |Java

public class Person.Builder

Builder for the immutable Person class.

Summary

Public constructors
`Builder()` Creates a new, empty `Builder`.

Public methods
`@NonNull Person`	`build()` Creates and returns the `Person` this builder represents.
`@NonNull Person.Builder`	`setBot(boolean bot)` Sets whether or not this `Person` represents a machine rather than a human.
`@NonNull Person.Builder`	`setIcon(@Nullable IconCompat icon)` Set an icon for this `Person`.
`@NonNull Person.Builder`	`setImportant(boolean important)` Sets whether this is an important person.
`@NonNull Person.Builder`	`setKey(@Nullable String key)` Set a unique identifier for this `Person`.
`@NonNull Person.Builder`	`setName(@Nullable CharSequence name)` Give this `Person` a name to use for display.
`@NonNull Person.Builder`	`setUri(@Nullable String uri)` Set a URI for this `Person` which can be any of the following:

Public constructors

Builder

Added in 1.1.0

public Builder()

Creates a new, empty Builder.

Public methods

build

Added in 1.1.0

public @NonNull Person build()

Creates and returns the Person this builder represents.

setBot

Added in 1.1.0

public @NonNull Person.Builder setBot(boolean bot)

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

public @NonNull Person.Builder setIcon(@Nullable IconCompat icon)

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

public @NonNull Person.Builder setImportant(boolean important)

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

public @NonNull Person.Builder setKey(@Nullable String key)

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

public @NonNull Person.Builder setName(@Nullable CharSequence name)

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

public @NonNull Person.Builder setUri(@Nullable String uri)

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

The String representation of a CONTENT_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.