Person.Builder

Builder(person: Person)

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

Builder(namespace: String, id: String, name: String)

Constructor for Person.Builder.

fun addAlternateName(alternateName: String): T

Adds an alias for the item.

@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T

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

fun build(): Person

Builds the Person.

fun build(): Thing

Builds a Thing object.

fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

@ExperimentalAppSearchApi
fun clearPotentialActions(): T

Clear all the potential actions for this document.

fun setAdditionalNames(
    additionalNames: (Mutable)List<Person.AdditionalName!>
): T

Sets a list of AdditionalName for that Person.

Only types defined in AdditionalName.NameType are accepted.

fun setAffiliations(affiliations: (Mutable)List<String!>): T

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

fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T

Sets a list of aliases for the item.

fun setBot(isBot: Boolean): T

Sets whether this Person is a bot.

fun setContactPoints(contactPoints: (Mutable)List<ContactPoint!>): T

Sets a list of ContactPoint for the Person.

More information could be found in ContactPoint.

fun setCreationTimestampMillis(creationTimestampMillis: Long): T

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.

fun setDescription(description: String?): T

Sets the description for the item.

fun setDocumentScore(documentScore: Int): T

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.

fun setDocumentTtlMillis(documentTtlMillis: Long): T

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.

fun setExternalUri(externalUri: Uri): T

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.

fun setFamilyName(familyName: String): T

Sets the family name of this Person.

fun setGivenName(givenName: String): T

Sets the given name of this Person.

@ExperimentalAppSearchApi
fun setImage(image: String?): T

Sets the URL for an image of the item.

fun setImageUri(imageUri: Uri): T

Sets the Uri of the profile image for the Person.

fun setImportant(isImportant: Boolean): T

Sets whether this Person is important.

fun setMiddleName(middleName: String): T

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

fun setName(name: String?): T

Sets the name of the item.

fun setNotes(notes: (Mutable)List<String!>): T

Sets the notes about this Person.

@ExperimentalAppSearchApi
fun setPotentialActions(
    newPotentialActions: (Mutable)List<PotentialAction!>?
): T

Sets a list of potential actions for this document.

fun setRelations(relations: (Mutable)List<String!>): T

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

fun setUrl(url: String?): T

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.