Package apple.uikit.protocol

Interface UIDropSession

All Superinterfaces:

NSProgressReporting, UIDragDropSession

public interface UIDropSession
extends UIDragDropSession, NSProgressReporting

API-Since: 11.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UIDropSession.Block_loadObjectsOfClassCompletion

Method Summary

Modifier and Type	Method	Description
@NotNull NSProgress	loadObjectsOfClassCompletion(@NotNull NSItemProviderReading aClass, @NotNull UIDropSession.Block_loadObjectsOfClassCompletion completion)	A convenience method that can be used only during the UIDropInteractionDelegate's implementation of `-dropInteraction:performDrop:`.
@Nullable UIDragSession	localDragSession()	The `UIDragSession` that corresponds to this `UIDropSession`.
long	progressIndicatorStyle()	The kind of progress and cancellation UI that UIKit will display if handling this session's drop takes a significant amount of time.
void	setProgressIndicatorStyle(long value)	The kind of progress and cancellation UI that UIKit will display if handling this session's drop takes a significant amount of time.

Methods inherited from interface apple.foundation.protocol.NSProgressReporting

progress

Methods inherited from interface apple.uikit.protocol.UIDragDropSession

allowsMoveOperation, canLoadObjectsOfClass, hasItemsConformingToTypeIdentifiers, isRestrictedToDraggingApplication, items, locationInView

Method Detail

loadObjectsOfClassCompletion

@NotNull
@NotNull NSProgress loadObjectsOfClassCompletion(@NotNull
                                                 @NotNull NSItemProviderReading aClass,
                                                 @NotNull
                                                 @NotNull UIDropSession.Block_loadObjectsOfClassCompletion completion)

A convenience method that can be used only during the UIDropInteractionDelegate's implementation of `-dropInteraction:performDrop:`. Asynchronously instantiates objects of the provided class for each drag item that can do so. The completion handler is called on the main queue, with an array of all objects that were created, in the same order as `items`. The progress returned is an aggregate of the progress for all objects that are loaded.

localDragSession

@Nullable
@Nullable UIDragSession localDragSession()

The `UIDragSession` that corresponds to this `UIDropSession`. If the drag was started in a different app, this is nil.

progressIndicatorStyle

long progressIndicatorStyle()

The kind of progress and cancellation UI that UIKit will display if handling this session's drop takes a significant amount of time. The default value is UIDropSessionProgressIndicatorStyleDefault, meaning that some progress UI will be shown. If you show your own progress indicator, hide the system progress UI by setting this property to UIDropSessionProgressIndicatorStyleNone.

setProgressIndicatorStyle

void setProgressIndicatorStyle(long value)

The kind of progress and cancellation UI that UIKit will display if handling this session's drop takes a significant amount of time. The default value is UIDropSessionProgressIndicatorStyleDefault, meaning that some progress UI will be shown. If you show your own progress indicator, hide the system progress UI by setting this property to UIDropSessionProgressIndicatorStyleNone.