Creates a person object with the specified name, contact information, and flag indicating whether the person is the current device user.
- iOS 12.0+
- Mac Catalyst 13.0+
- watchOS 5.0+
A string containing information that your app uses to identify the user. You can create a person handle from an email address, phone number, or account name associated with the user.
The name of the user, specified as a set of name components.
The string you display for the user’s name.
An image of the person.
The identifier associated with the user's
CNContactobject. Specify a value for this parameter when the user has a corresponding entry in the Contacts database.
A custom string that you use to identify people in your app.
A Boolean value indicating whether the person is the current device user.
An initialized person object or
nil if the object could not be created.
It’s essential that you properly set
is when using Messaging intents. For example, if the message sender for an outgoing message is also the user of the device, set
true. Similarly, when creating the recipient array for an incoming message—which should include the current user of the device—set
true for the person in the recipient list that is the current device user, and set
false for all other recipients.
Use this method when creating person objects you plan to return as part of a response to Siri. Always specify as much information as possible about the user. This method makes copies of the
custom parameters instead of keeping the originals.