Platforms to show: All Mac Windows Linux Cross-Platform

Back to PHCollectionListChangeRequestMBS class.

PHCollectionListChangeRequestMBS.available as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Checks whether class is available.

Should return true on MacOS 10.15 or newer.

PHCollectionListChangeRequestMBS.changeRequestForCollectionList(collectionList as PHCollectionListMBS) as PHCollectionListChangeRequestMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Creates a request for modifying the specified collection list.

collectionList: The collection list to be modified.

Returns a collection list change request.

After you create a change request within a photo library change block, propose changes to the collection’s title or list of child collections with the properties and instance methods of the change request. After Photos runs your change block, the collection list reflects your changes. For details on change blocks, see PHPhotoLibraryMBS.
Use this method when modifying a collection list’s metadata or when adding or removing child collections without regard to their arrangement. To work with indexes in the list of child collections, use the changeRequestForCollectionList method instead.

See also:

PHCollectionListChangeRequestMBS.changeRequestForCollectionList(collectionList as PHCollectionListMBS, childCollections as PHFetchResultMBS) as PHCollectionListChangeRequestMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Creates a request for modifying the specified collection list, with a fetch result for tracking changes.

collectionList: The collection list to be modified.
childCollections: A fetch result listing the child collections in the collection.

Returns a collection list change request.

After you create a change request within a photo library change block, propose changes to the collection’s title or list of child collections with the properties and instance methods of the change request. After Photos runs your change block, the collection list reflects your changes. For details on change blocks, see PHPhotoLibraryMBS.

Use this method when you need to insert, remove, or rearrange collections at specified indexes in the collection list. By passing in a fetch result reflecting what your app sees as the current state of the collection’s membership, the Photos framework can ensure that the indexes you specify are valid even if the collection has changed since you last fetched it. If you don’t need to work with indexes in the list of child collections, you can use the changeRequestForCollectionList method instead.

See also:

PHCollectionListChangeRequestMBS.creationRequestForCollectionListWithTitle(title as string) as PHCollectionListChangeRequestMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Creates a request for adding a new collection list to the Photos library.

title: A name for the new collection list.

Returns a collection list creation request.

Call this method within a photo library change block to create a new collection list. For details on change blocks, see PHPhotoLibraryMBS.
To add collections to the newly created collection list or to change its title, use the methods listed in Modifying Collection Lists. To reference the newly created collection collection list later in the same change delegate or after the change delegate completes, use the placeholderForCreatedCollectionListMBS property to retrieve a placeholder object.

PHCollectionListChangeRequestMBS.deleteCollectionLists(collectionLists() as PHCollectionListMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Requests to delete the specified asset collections.

collectionLists: An array of PHCollectionListMBS objects to be deleted.

Call this method within a photo library change block to delete collection lists. For details on change blocks, see PHPhotoLibraryMBS.

Deleting a collection list also deletes any child collections it contains. To preserve those collections, remove them from the collection list (with the removeChildCollections or removeChildCollectionsAtIndexes method) before deleting it. Deleting a collection list does not delete assets contained in its child collections.

The items on this page are in the following plugins: MBS Mac64bit Plugin.


The biggest plugin in space...