View on GitHub
DocumentPickerCoordinator Class Reference
DocumentPickerCoordinator
public final class DocumentPickerCoordinator : NSObjectextension DocumentPickerCoordinator: UIDocumentPickerDelegateextension DocumentPickerCoordinator: UIDropInteractionDelegateUndocumented
-
The object that acts as the delegate of the document picker coordinator.
Declaration
Swift
public weak var delegate: DocumentPickerCoordinatorDelegate? -
Used to filter out PDFs when there are already imported images.
Declaration
Swift
public var isPDFSelectionAllowed: Bool -
Once the user has selected one or several documents from a picker, this has to be dismissed. Files explorer dismissal is handled by the OS and drag and drop does not need to be dismissed. However, the Gallery picker should be dismissed once the images has been imported.
It is also used to check if the
currentPickerViewControlleris still present so an error dialog can be shown fro thereDeclaration
Swift
private(set) public var currentPickerDismissesAutomatically: Bool { get } -
The current picker
UIViewController. Used to show an error after validating picked documents.Declaration
Swift
private(set) public var currentPickerViewController: UIViewController? { get } -
Indicates if the user granted access to the gallery before. Used to start caching images before showing the Gallery picker.
Declaration
Swift
public var isGalleryPermissionGranted: Bool { get } -
Designated initializer for the
DocumentPickerCoordinator.Declaration
Swift
public init(giniConfiguration: GiniConfiguration)Parameters
giniConfigurationGiniConfigurationuse to configure the pickers. -
Starts caching gallery images. Gallery permissions should have been granted before using it.
Declaration
Swift
public func startCaching() -
Set up the drag and drop feature in a view.
Note
Only available in iOS >= 11Declaration
Swift
@available(iOS 11.0, *) public func setupDragAndDrop(in view: UIView)Parameters
viewView that will handle the drop interaction.
-
Shows the Gallery picker from a given viewController
Declaration
Swift
public func showGalleryPicker(from viewController: UIViewController)Parameters
viewControllerView controller which presentes the gallery picker
-
Shows the File explorer picker from a given viewController
Declaration
Swift
public func showDocumentPicker(from viewController: UIViewController, device: UIDevice = UIDevice.current)Parameters
viewControllerView controller which presentes the gallery picker
-
Dimisses the
currentPickerViewControllerDeclaration
Swift
public func dismissCurrentPicker(completion: @escaping () -> Void)Parameters
completionCompletion block executed once the picker is dismissed
-
Undocumented
Declaration
Swift
func gallery(_ coordinator: GalleryCoordinator, didSelectImageDocuments imageDocuments: [GiniImageDocument]) -
Undocumented
Declaration
Swift
func gallery(_ coordinator: GalleryCoordinator, didCancel: Void)
-
Undocumented
Declaration
Swift
public func documentPicker(_ controller: UIDocumentPickerViewController, didPickDocumentsAt urls: [URL]) -
Undocumented
Declaration
Swift
public func documentPicker(_ controller: UIDocumentPickerViewController, didPickDocumentAt url: URL) -
Undocumented
Declaration
Swift
public func documentPickerWasCancelled(_ controller: UIDocumentPickerViewController)
-
Undocumented
Declaration
Swift
public func dropInteraction(_ interaction: UIDropInteraction, canHandle session: UIDropSession) -> Bool -
Undocumented
Declaration
Swift
public func dropInteraction(_ interaction: UIDropInteraction, sessionDidUpdate session: UIDropSession) -> UIDropProposal -
Undocumented
Declaration
Swift
public func dropInteraction(_ interaction: UIDropInteraction, performDrop session: UIDropSession)