Initializer

init(personHandle:nameComponents:displayName:image:contactIdentifier:customIdentifier:)

Creates a person object with the specified name and contact information.

Declaration

convenience init(personHandle: INPersonHandle, nameComponents: PersonNameComponents?, displayName: String?, image: INImage?, contactIdentifier: String?, customIdentifier: String?)

Parameters

personHandle

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.

nameComponents

The name of the user, specified as a set of name components.

displayName

The string you display for the user’s name.

image

An image of the person.

contactIdentifier

The identifier associated with the user's CNContact object. Specify a value for this parameter when the user has a corresponding entry in the Contacts database.

customIdentifier

A custom string that you use to identify people in your app.

Return Value

An initialized person object or nil if the object could not be created.

Discussion

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 personHandle, nameComponents, displayName, image, contactIdentifier, and customIdentifier parameters instead of keeping the originals.

See Also

Initializing a Person Object

init(personHandle: INPersonHandle, nameComponents: PersonNameComponents?, displayName: String?, image: INImage?, contactIdentifier: String?, customIdentifier: String?, isMe: Bool)

Creates a person object with the specified name, contact information, and flag indicating whether the person is the current device user.

init(handle: String, displayName: String?, contactIdentifier: String?)

Creates a person object with the specified display name and contact information.

Deprecated
init(handle: String, nameComponents: PersonNameComponents, contactIdentifier: String?)

Creates a person object with the specified display name and contact information.

Deprecated

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software