Platforms to show: All Mac Windows Linux Cross-Platform

Back to PHFetchOptionsMBS class.

PHFetchOptionsMBS.fetchLimit as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The maximum number of objects to include in the fetch result.

With the default fetch limit of zero, Photos returns all requested assets or collections in a fetch result. Change this value to fetch more efficiently in situations where a potentially very large result is not needed. For example, to fetch only the most recently captured asset, call the fetchAssetsWithOptions method, using the sortDescriptors property to sort in descending date order, and setting a fetch limit of one.
(Read and Write property)

PHFetchOptionsMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The internal object reference.

(Read and Write property)

PHFetchOptionsMBS.includeAllBurstAssets as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A Boolean value that determines whether the fetch result includes all assets from burst photo sequences.

When the user takes a sequence of photos in burst mode with the Camera app (on supported devices), the Photos app user interface groups the resulting assets together and allows the user to select favorite members of the sequence. Photos also automatically marks members of the sequence as potential user favorites.

If the value is false (the default), fetches that include burst photo sequences return only the user-picked members and representative asset of each sequence. If the value is true, such fetches include all assets in each sequence.
(Read and Write property)

PHFetchOptionsMBS.includeAssetSourceTypes as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The set of source types for which to include assets in the fetch result.

Asset source types identify the means by which an asset enters the Photos library, and affect the possible actions you can perform on an asset. For example, assets synced from iTunes cannot be edited or deleted.

The SourceType type is an option set—to include multiple source types in the same query, combine type constants with the bitwise OR operator. See SourceType constants in PHAssetMBS class.
(Read and Write property)

PHFetchOptionsMBS.includeHiddenAssets as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A Boolean value that determines whether the fetch result includes assets marked as hidden.

If the value is false (the default), fetches exclude assets whose hidden property is true. If the value is true, fetches include all assets regardless of their hidden state.
(Read and Write property)

PHFetchOptionsMBS.predicate as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A predicate that specifies which properties to select results by and that also specifies any constraints on selection.

Construct a predicate with the properties of the class of objects that you want to fetch
(Read and Write property)

PHFetchOptionsMBS.wantsIncrementalChangeDetails as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A Boolean value that determines whether your app receives detailed change information for the objects in the fetch result.

If you have registered a change observer with the shared PHPhotoLibraryMBS object, fetching assets or collections automatically registers your observer to receive information about later changes to the fetch result and about the objects it contains. For a fetch result, change information (a PHFetchResultChangeDetailsMBS object) can include a detailed list of incremental differences from the previous state of the fetch result, such as new photos captured since the original fetch.

If true (the default), Photos sends detailed incremental changes when such information is available. If false, Photos tells your app only when the fetch result has changed (in which case you can perform the fetch again to receive updated results).
(Read and Write property)

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


The biggest plugin in space...