Contents

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

Creates a person 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 that contains information 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 initialization fails.

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

Creating a person