Person.Builder
class Person.Builder
Builder class for Person.
Summary
Public constructors |
|---|
|
Constructor for |
|
Constructor for |
Public functions |
|
|---|---|
T |
addAlternateName(alternateName: String)Adds an alias for the item. |
T |
@ExperimentalAppSearchApiAdd a new action to the list of potential actions for this document. |
Person |
build()Builds the |
Thing |
build()Builds a |
T |
Clears the aliases, if any, for the item. |
T |
Clear all the potential actions for this document. |
T |
setAdditionalNames(Sets a list of |
T |
setAffiliations(affiliations: (Mutable)List<String!>)Sets a list of affiliations for this |
T |
setAlternateNames(alternateNames: (Mutable)List<String!>?)Sets a list of aliases for the item. |
T |
Sets whether this |
T |
setContactPoints(contactPoints: (Mutable)List<ContactPoint!>)Sets a list of |
T |
setCreationTimestampMillis(creationTimestampMillis: Long)Sets the creation timestamp for the current AppSearch entity, in milliseconds using the |
T |
setDescription(description: String?)Sets the description for the item. |
T |
setDocumentScore(documentScore: Int)Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using |
T |
setDocumentTtlMillis(documentTtlMillis: Long)Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds. |
T |
setExternalUri(externalUri: Uri) |
T |
setFamilyName(familyName: String)Sets the family name of this |
T |
setGivenName(givenName: String)Sets the given name of this |
T |
@ExperimentalAppSearchApiSets the URL for an image of the item. |
T |
setImageUri(imageUri: Uri) |
T |
setImportant(isImportant: Boolean)Sets whether this |
T |
setMiddleName(middleName: String)Sets the middle name of this |
T |
Sets the name of the item. |
T |
Sets the notes about this |
T |
@ExperimentalAppSearchApiSets a list of potential actions for this document. |
T |
setRelations(relations: (Mutable)List<String!>)Sets a list of relations for this |
T |
Sets the deeplink URL of the item. |
Protected properties |
|
|---|---|
(Mutable)List<String!>! |
|
Long |
|
String! |
|
Int |
|
Long |
|
String! |
|
String! |
|
String! |
|
String! |
|
(Mutable)List<PotentialAction!>! |
|
String! |
Public constructors
Builder
Builder(person: Person)
Constructor for Builder with all the existing values of an Person.
Builder
Builder(namespace: String, id: String, name: String)
Constructor for Person.Builder.
| Parameters | |
|---|---|
namespace: String |
Namespace for the |
id: String |
Unique identifier for the |
name: String |
The searchable full name of this |
Public functions
addAlternateName
fun addAlternateName(alternateName: String): T
Adds an alias for the item.
addPotentialAction
@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T
Add a new action to the list of potential actions for this document.
clearAlternateNames
fun clearAlternateNames(): T
Clears the aliases, if any, for the item.
clearPotentialActions
@ExperimentalAppSearchApi
fun clearPotentialActions(): T
Clear all the potential actions for this document.
setAdditionalNames
fun setAdditionalNames(
additionalNames: (Mutable)List<Person.AdditionalName!>
): T
Sets a list of AdditionalName for that Person.
Only types defined in AdditionalName.NameType are accepted.
setAffiliations
fun setAffiliations(affiliations: (Mutable)List<String!>): T
Sets a list of affiliations for this Person. Like company, school, etc.
setAlternateNames
fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T
Sets a list of aliases for the item.
setContactPoints
fun setContactPoints(contactPoints: (Mutable)List<ContactPoint!>): T
Sets a list of ContactPoint for the Person.
More information could be found in ContactPoint.
setCreationTimestampMillis
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.
setDescription
fun setDescription(description: String?): T
Sets the description for the item.
setDocumentScore
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.
setDocumentTtlMillis
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.
setExternalUri
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.
setFamilyName
fun setFamilyName(familyName: String): T
Sets the family name of this Person.
setGivenName
fun setGivenName(givenName: String): T
Sets the given name of this Person.
setImage
@ExperimentalAppSearchApi
fun setImage(image: String?): T
Sets the URL for an image of the item.
setImportant
fun setImportant(isImportant: Boolean): T
Sets whether this Person is important.
setMiddleName
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".
setNotes
fun setNotes(notes: (Mutable)List<String!>): T
Sets the notes about this Person.
setPotentialActions
@ExperimentalAppSearchApi
fun setPotentialActions(
newPotentialActions: (Mutable)List<PotentialAction!>?
): T
Sets a list of potential actions for this document.
setRelations
fun setRelations(relations: (Mutable)List<String!>): T
Sets a list of relations for this Person, like "Father" or "Mother".
setUrl
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.