Person.Builder

protected List<String> mAlternateNames

protected long mCreationTimestampMillis

protected String mDescription

protected int mDocumentScore

protected long mDocumentTtlMillis

protected final String mId

protected String mImage

protected String mName

protected final String mNamespace

protected List<PotentialAction> mPotentialActions

protected String mUrl

public Builder(@NonNull Person person)

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

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

Constructor for Person.Builder.

public @NonNull T addAlternateName(@NonNull String alternateName)

Adds an alias for the item.

public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)

Add a new action to the list of potential actions for this document.

public @NonNull Person build()

Builds the Person.

public @NonNull Thing build()

Builds a Thing object.

public @NonNull T clearAlternateNames()

Clears the aliases, if any, for the item.

public @NonNull T clearPotentialActions()

Clear all the potential actions for this document.

public @NonNull T setAdditionalNames(@NonNull List<Person.AdditionalName> additionalNames)

Sets a list of AdditionalName for that Person.

Only types defined in AdditionalName.NameType are accepted.

public @NonNull T setAffiliations(@NonNull List<String> affiliations)

Sets a list of affiliations for this Person. Like company, school, etc.

public @NonNull T setBot(boolean isBot)

Sets whether this Person is a bot.

public @NonNull T setContactPoints(@NonNull List<ContactPoint> contactPoints)

Sets a list of ContactPoint for the Person.

More information could be found in ContactPoint.

public @NonNull T setCreationTimestampMillis(long creationTimestampMillis)

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.

This timestamp refers to the creation time of the AppSearch entity, not when the document is written into AppSearch.

If not set, then the current timestamp will be used.

See androidx.appsearch.annotation.Document.CreationTimestampMillis for more information on creation timestamp.

public @NonNull T setDescription(@Nullable String description)

Sets the description for the item.

public @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.

See androidx.appsearch.annotation.Document.Score for more information on score.

public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.

The document will be automatically deleted when the TTL expires.

If not set, then the document will never expire.

See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.

public @NonNull T setExternalUri(@NonNull Uri externalUri)

Sets an external Uri for this Person. Or null if no Uri is provided. A Uri can be any of the following:

• A CONTENT_LOOKUP_URI.
• A mailto: schema*
• A tel: schema*

For mailto: and tel: URI schemes, it is recommended that the path portion refers to a valid contact in the Contacts Provider.

public @NonNull T setFamilyName(@NonNull String familyName)

Sets the family name of this Person.

public @NonNull T setGivenName(@NonNull String givenName)

Sets the given name of this Person.

public @NonNull T setImage(@Nullable String image)

Sets the URL for an image of the item.

public @NonNull T setImageUri(@NonNull Uri imageUri)

Sets the Uri of the profile image for the Person.

public @NonNull T setImportant(boolean isImportant)

Sets whether this Person is important.

public @NonNull T setMiddleName(@NonNull String middleName)

Sets the middle name of this Person.

For Person with multiple middle names, they can all be set in this single string. Each middle name could be separated by a whitespace like "middleName1 middleName2 middleName3".

public @NonNull T setName(@Nullable String name)

Sets the name of the item.

public @NonNull T setNotes(@NonNull List<String> notes)

Sets the notes about this Person.

public @NonNull T setRelations(@NonNull List<String> relations)

Sets a list of relations for this Person, like "Father" or "Mother".

public @NonNull T setUrl(@Nullable String url)

Sets the deeplink URL of the item.

If this item can be displayed by any system UI surface, or can be read by another Android package, through one of the androidx.appsearch.app.SetSchemaRequest.Builder methods, this url should act as a deeplink into the activity that can open it. Callers should be able to construct an ACTION_VIEW intent with the url as the setData to view the item inside your application.

See Allowing Other Apps to Start Your Activity for more details on how to make activities in your app open for use by other apps by defining intent filters.