Contents

fetchCollectionLists(with:subtype:options:)

Retrieves collection lists of the specified type.

Declaration

class func fetchCollectionLists(with collectionListType: PHCollectionListType, subtype: PHCollectionListSubtype, options: PHFetchOptions?) -> PHFetchResult<PHCollectionList>

Parameters

  • collectionListType:

    A type of collection list. See Phcollectionlisttype.

  • subtype:

    A subtype of collection list. See Phcollectionlistsubtype.

  • options:

    Options that specify a filter predicate and sort order for the fetched collection lists, or nil to use default options. For details, see Phfetchoptions.

Return Value

A fetch result that contains the requested PHCollectionList objects, or an empty fetch result if no objects match the request.

Discussion

By default, the returned PHFetchResult object contains all collection lists with the specified type and subtype. To retrieve a more specific set of collection lists, provide a PHFetchOptions object containing a filter predicate.

See Also

Fetching Collection Lists