Instance Method

containers(matching:)

Fetches all containers matching the specified predicate.

Declaration

func containers(matching predicate: NSPredicate?) throws -> [CNContainer]

Parameters

predicate

The predicate to use to fetch matching containers. Set this property to nil to match all containers.

error

Error information, if an error occurred.

Return Value

An array of CNContainer objects that match the predicate.

Discussion

A container holds a collection of contacts, and a contact can be in only one container. CardDAV accounts usually have only one container of contacts. Exchange accounts may have multiple containers, where each container represents an Exchange folder.

This method returns an empty array when no matching container is found. In case of an error this method returns nil. You should use only the predicates defined CNContainer class. Compound predicates are not supported.

See Also

Fetching Groups and Containers

func defaultContainerIdentifier() -> String

Returns the identifier of the default container.

func groups(matching: NSPredicate?) -> [CNGroup]

Fetches all groups matching the specified predicate.

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