Contents

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

Creates a person with the specified name, contact, and alias information.

Declaration

convenience init(personHandle: INPersonHandle, nameComponents: PersonNameComponents?, displayName: String?, image: INImage?, contactIdentifier: String?, customIdentifier: String?, aliases: [INPersonHandle]?, suggestionType: INPersonSuggestionType)

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 can use to identify people in your app.

  • aliases:

    An array of Inpersonhandle objects containing alternate ways of identifying the user.

  • suggestionType:

    The contact information to surface in interactions involving the user. Use this property to identify a user by their social media account name or instant messaging address, instead of by their actual name.

Return Value

An initialized person object or nil if initialization fails.

Discussion

Use this method when you want to create person objects with additional information such as email addresses or phone numbers. This method also lets you suggest how you want to identify the person when donating interactions to the system. For example, you might ask the system to identify the user by their social media account name instead of by their actual name.

Specify as much information as possible about the user. This method makes copies of the personHandle, nameComponents, displayName, image, contactIdentifier, customIdentifier, and aliases parameters instead of keeping the originals.

See Also

Creating a person