INPerson
Information about a person participating in a SiriKit interaction.
Declaration
class INPersonMentioned in
Overview
SiriKit uses INPerson objects to represent people with many different roles, including the sender or recipient of calls and messages, the payer or payee of a financial transaction, or the driver of a vehicle. You also use person objects to identify the corresponding contact in your app and to communicate information about that contact back to SiriKit.
When resolving the parameters of an intent, use any provided INPerson objects to identify the corresponding contacts in your app. A person object contains information provided by the initial request, which could be as little as a single name spoken by the person interacting with Siri. After identifying the contact, create a new INPerson object and fill it with the information that you need to identify that contact again later. For example, you might specify a value for personHandle property that contains the information about how your app identifies that contact.
When resolving the identities of contacts, SiriKit leverages the information in the device owner’s contacts database when that information is available. If the owner denies your app access to their contacts, SiriKit can’t use that information, which might cause many properties of a person object to be nil. Because the INPerson class conforms to the INSpeakable protocol, though, SiriKit still populates the spokenPhrase property with what the person interacting with Siri said, and you can use that information to try to identify the contact. For more information about that protocol, see INSpeakable.
Topics
Creating a person
init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:)init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:isMe:)init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:relationship:)init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:isMe:suggestionType:)init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:aliases:suggestionType:)init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:isContactSuggestion:suggestionType:)
Accessing the name
Accessing the person’s identity
Accessing app-specific identifiers
Accessing suggestion details
Accessing relationship details
Accessing matched people
Deprecated
Initializers
init(coder:)init(handle:displayName:contactIdentifier:)init(handle:nameComponents:contactIdentifier:)init(handle:nameComponents:displayName:image:contactIdentifier:)