Person.Builder

Artifact: androidx.appsearch:appsearch-builtin-types

Added in 1.1.0

Kotlin |Java

@Document.BuilderProducer
public final class Person.Builder extends Person.BuilderBase

java.lang.Object
↳	androidx.appsearch.builtintypes.Thing.BuilderBase
	↳	androidx.appsearch.builtintypes.Person.BuilderBase
		↳	androidx.appsearch.builtintypes.Person.Builder

Builder class for Person.

Summary

Public constructors
`Builder(@NonNull Person person)` Constructor for `Builder` with all the existing values of an `Person`.
`Builder(@NonNull String namespace, @NonNull String id, @NonNull String name)` Constructor for `Person.Builder`.

Inherited methods

From androidx.appsearch.builtintypes.Person.BuilderBase

`@NonNull Person`	`build()` Builds the `Person`.
`@NonNull T`	`setAdditionalNames(@NonNull List<Person.AdditionalName> additionalNames)` Sets a list of `AdditionalName` for that `Person`.
`@NonNull T`	`setAffiliations(@NonNull List<String> affiliations)` Sets a list of affiliations for this `Person`.
`@NonNull T`	`setBot(boolean isBot)` Sets whether this `Person` is a bot.
`@NonNull T`	`setContactPoints(@NonNull List<ContactPoint> contactPoints)` Sets a list of `ContactPoint` for the `Person`.
`@NonNull T`	`@ExperimentalAppSearchApi setExternalUri(@NonNull String externalUri)` Sets the external `Uri` from a `String` representation for this `Person`.
`@NonNull T`	`setExternalUri(@NonNull Uri externalUri)` Sets an external `Uri` for this `Person`.
`@NonNull T`	`setFamilyName(@NonNull String familyName)` Sets the family name of this `Person`.
`@NonNull T`	`setGivenName(@NonNull String givenName)` Sets the given name of this `Person`.
`@NonNull T`	`@ExperimentalAppSearchApi setImageUri(@NonNull String imageUri)` Sets the `Uri` of the profile image from a `String` representation for the `Person`.
`@NonNull T`	`setImageUri(@NonNull Uri imageUri)` Sets the `Uri` of the profile image for the `Person`.
`@NonNull T`	`setImportant(boolean isImportant)` Sets whether this `Person` is important.
`@NonNull T`	`@ExperimentalAppSearchApi setIsBot(boolean isBot)` Sets whether this `Person` is a bot.
`@NonNull T`	`@ExperimentalAppSearchApi setIsImportant(boolean isImportant)` Sets whether this `Person` is important.
`@NonNull T`	`setMiddleName(@NonNull String middleName)` Sets the middle name of this `Person`.
`@NonNull T`	`setNotes(@NonNull List<String> notes)` Sets the notes about this `Person`.
`@NonNull T`	`setRelations(@NonNull List<String> relations)` Sets a list of relations for this `Person`, like "Father" or "Mother".

From androidx.appsearch.builtintypes.Thing.BuilderBase

`@NonNull T`	`addAlternateName(@NonNull String alternateName)` Adds an alias for the item.
`@NonNull T`	`@ExperimentalAppSearchApi addPotentialAction(@NonNull PotentialAction newPotentialAction)` Add a new action to the list of potential actions for this document.
`@NonNull Thing`	`build()` Builds a `Thing` object.
`@NonNull T`	`clearAlternateNames()` Clears the aliases, if any, for the item.
`@NonNull T`	`@ExperimentalAppSearchApi clearPotentialActions()` Clear all the potential actions for this document.
`void`	`resetIfBuilt()` If built, make a copy of previous data for every field so that the builder can be reused.
`@NonNull T`	`setAlternateNames(@Nullable List<String> alternateNames)` Sets a list of aliases for the item.
`@NonNull T`	`setCreationTimestampMillis(long creationTimestampMillis)` Sets the creation timestamp for the current AppSearch entity, in milliseconds using the `currentTimeMillis` time base.
`@NonNull T`	`setDescription(@Nullable String description)` Sets the description for the item.
`@NonNull T`	`setDocumentScore(int documentScore)` Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using `RANKING_STRATEGY_DOCUMENT_SCORE`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
`@NonNull T`	`@ExperimentalAppSearchApi setImage(@Nullable String image)` Sets the URL for an image of the item.
`@NonNull T`	`setName(@Nullable String name)` Sets the name of the item.
`@NonNull T`	`@ExperimentalAppSearchApi setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)` Sets a list of potential actions for this document.
`@NonNull T`	`setUrl(@Nullable String url)` Sets the deeplink URL of the item.

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull Person person)

Constructor for Builder with all the existing values of an Person.

Builder

Added in 1.1.0

public Builder(@NonNull String namespace, @NonNull String id, @NonNull String name)

Constructor for Person.Builder.

Parameters
`@NonNull String namespace`	Namespace for the `Person` Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the `Person` Document. See `Document.Id`.
`@NonNull String name`	The searchable full name of this `Person`. E.g. "Larry Page", or "Page, Larry".