Person
@Document(name = "builtin:Person")
class Person : Thing
AppSearch document representing a Person entity modeled after Person.
The Person document includes commonly searchable properties such as name, organization, and notes, as well as contact information such as phone numbers, email addresses, etc, grouped by their label. The labeled contact information is present in a nested ContactPoint document.
Summary
Nested types |
|---|
class Person.AdditionalNameHolds type information for additional names for Person. |
class Person.BuilderBuilder class for |
Public functions |
|
|---|---|
(Mutable)List<String!> |
Returns a list of additional names for this |
(Mutable)List<String!> |
Returns a list of affiliation for this |
(Mutable)List<ContactPoint!> |
Returns a list of |
Uri? |
Returns an external uri for this |
String? |
Returns the family (or last) name for this |
String? |
Returns the given (or first) name for this |
Uri? |
|
String? |
Returns the middle name(s) for this |
(Mutable)List<String!> |
getNotes()Returns the notes about this |
(Mutable)List<String!> |
Returns a list of relations for this |
(Mutable)List<Person.AdditionalName!> |
Returns a list of |
Boolean |
isBot()Returns whether this |
Boolean |
Returns whether this |
Inherited functions |
||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public functions
getAdditionalNames
fun getAdditionalNames(): (Mutable)List<String!>
Returns a list of additional names for this Person.
Additional names can include something like phonetic names, or nicknames.
Different from getTypedAdditionalNames, the return value doesn't include type information for the additional names.
getAffiliations
fun getAffiliations(): (Mutable)List<String!>
Returns a list of affiliation for this Person. Like company, school, etc.
For a contact with the title "Software Engineer" in a department "Engineering" at a company "Cloud Company", this can include a flattened value of "Software Engineer, Engineering, Cloud Company".
getContactPoints
fun getContactPoints(): (Mutable)List<ContactPoint!>
Returns a list of ContactPoint.
More information can be found in ContactPoint.
getExternalUri
fun getExternalUri(): Uri?
Returns 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.
getFamilyName
fun getFamilyName(): String?
Returns the family (or last) name for this Person.
getGivenName
fun getGivenName(): String?
Returns the given (or first) name for this Person.
getMiddleName
fun getMiddleName(): String?
Returns the middle name(s) for this Person.
For a Person with multiple middle names, this method returns a flattened and whitespace separated list. For example, "middle1 middle2 ..."
getNotes
fun getNotes(): (Mutable)List<String!>
Returns the notes about this Person.
getRelations
fun getRelations(): (Mutable)List<String!>
Returns a list of relations for this Person, like "Father" or "Mother".
getTypedAdditionalNames
fun getTypedAdditionalNames(): (Mutable)List<Person.AdditionalName!>
Returns a list of AdditionalName for this Person.
Additional names can include something like phonetic names, or nicknames.
Each AdditionalName contains type information for the additional name.
isBot
fun isBot(): Boolean
Returns whether this Person is a machine rather than a human.
isImportant
fun isImportant(): Boolean
Returns whether this Person is important to the user of this device with regards to how frequently they interact.