Platforms to show: All Mac Windows Linux Cross-Platform

Back to PHImageRequestOptionsMBS class.

PHImageRequestOptionsMBS.ProgressHandlerMBS(progress as double, error as NSErrorMBS, byref stop as boolean, info as Dictionary, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
delegate Photos MBS Mac64bit Plugin 20.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The delegate that Photos calls while downloading asset data from iCloud. Used by the progressHandler property.

If you request an image whose data is not on the local device, and you have enabled downloading with the networkAccessAllowed property, Photos calls your block periodically to report progress and to allow you to cancel the download.

Photos calls this block in an arbitrary serial queue. Dispatch to the main thread if your handler needs to update the user interface.

The method takes the following parameters:
progress: A floating-point value indicating the progress of the download. A value of 0.0 indicates that the download has just started, and a value of 1.0 indicates the download is complete.
error: An NSErrorMBS object describing an error that occurred when attempting to download the image, or nil if no errors have occurred.
stop: A pointer to a Boolean value. To cancel the download, set stop to true inside the block.
info: A dictionary providing additional information about the status of the image request. See Image Result Info Keys for possible keys and values. For example, a true value for the key PHImageResultIsDegradedKey indicates that Photos may send the full-quality version of the image later, depending on the value of the image request’s deliveryMode property.

If the method call is asynchronously dispatched to main thread, the stop property does not work.

Some methods using this delegate:

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


The biggest plugin in space...