summaryrefslogtreecommitdiff
path: root/CocoaSharp/Foundation/Protocols/Delegates/NSFileManagerDelegate.cs
blob: fff8375bacb3003d133de1df6859b5207a24ec4b (plain)
1
using ObjectiveC;
using System;
using SharpSwift.Attributes;
using System.Collections.Generic;

namespace Foundation
{
    /// <summary>
    /// The NSFileManagerDelegate protocol defines optional methods for managing operations involving the copying, moving, linking, or removal of files and directories. When you use an NSFileManager object to initiate a copy, move, link, or remove operation, the file manager asks its delegate whether the operation should begin at all and whether it should proceed when an error occurs.
    /// </summary>
    /// <see cref="https://developer.apple.com/library/prerelease/ios/documentation/Cocoa/Reference/NSFileManagerDelegate_Protocol/index.html#//apple_ref/occ/intf/NSFileManagerDelegate"/>
    [iOSVersion(5)]
    [Export("")]
    public interface NSFileManagerDelegate//: NSObjectProtocol
    {
        /// <summary>
        /// Asks the delegate if the file manager should move the specified item to the new URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to move the file or directory.</param>
        /// <param name="shouldMoveItemAtURL">The URL of the file or directory that the file manager wants to move.</param>
        /// <param name="toURL">The URL specifying the new location for the file or directory.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSURL shouldMoveItemAtURL, NSURL toURL);
        
        /// <summary>
        /// Asks the delegate if the file manager should move the specified item to the new path.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to move the file or directory.</param>
        /// <param name="shouldMoveItemAtPath">The path to the file or directory that the file manager wants to move.</param>
        /// <param name="toPath">The new path for the file or directory.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, string shouldMoveItemAtPath, string toPath);
        
        /// <summary>
        /// Asks the delegate if the move operation should continue after an error occurs while moving the item at the specified URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to move the item.</param>
        /// <param name="shouldProceedAfterError">The error that occurred while trying to move the item in srcURL.</param>
        /// <param name="movingItemAtURL">The URL of the file or directory that the file manager tried to move.</param>
        /// <param name="toURL">The URL of the intended destination for the item in srcURL.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, NSURL movingItemAtURL, NSURL toURL);
        
        /// <summary>
        /// Asks the delegate if the move operation should continue after an error occurs while moving the item at the specified path.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to move the item.</param>
        /// <param name="shouldProceedAfterError">The error that occurred while trying to move the item in srcPath.</param>
        /// <param name="movingItemAtPath">The path of the file or directory that the file manager tried to move.</param>
        /// <param name="toPath">The path of the intended destination for the item in srcPath.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, string movingItemAtPath, string toPath);
        
        /// <summary>
        /// Asks the delegate if the file manager should copy the specified item to the new URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to copy the file or directory.</param>
        /// <param name="shouldCopyItemAtURL">The URL of the file or directory that the file manager wants to copy.</param>
        /// <param name="toURL">The URL specifying the location for the copied file or directory.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSURL shouldCopyItemAtURL, NSURL toURL, bool NAME_YOUR_PARAMS = false);
        
        /// <summary>
        /// Asks the delegate if the file manager should copy the specified item to the new path.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to copy the file or directory.</param>
        /// <param name="shouldCopyItemAtPath">The path to the file or directory that the file manager wants to copy.</param>
        /// <param name="toPath">The new path for the copied file or directory.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, string shouldCopyItemAtPath, string toPath, bool NAME_YOUR_PARAMS = false);
        
        /// <summary>
        /// Asks the delegate if the move operation should continue after an error occurs while copying the item at the specified URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to copy the item.</param>
        /// <param name="shouldProceedAfterError">The error that occurred during the attempt to copy.</param>
        /// <param name="copyingItemAtURL">The URL or a file or directory that fileManager is attempting to copy.</param>
        /// <param name="toURL">The URL or a file or directory to which fileManager is attempting to copy.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, NSURL copyingItemAtURL, NSURL toURL, bool NAME_YOUR_PARAMS = false);
        
        /// <summary>
        /// Asks the delegate if the move operation should continue after an error occurs while copying the item at the specified path.
        /// </summary>
        /// <param name="fileManager">The NSFileManager object that sent this message.</param>
        /// <param name="shouldProceedAfterError">The error that occurred during the attempt to copy.</param>
        /// <param name="copyingItemAtPath">The path or a file or directory that fileManager is attempting to copy.</param>
        /// <param name="toPath">The path or a file or directory to which fileManager is attempting to copy.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, string copyingItemAtPath, string toPath, bool NAME_YOUR_PARAMS = false);
        
        /// <summary>
        /// Asks the delegate whether the item at the specified URL should be deleted.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to remove the file or directory.</param>
        /// <param name="shouldRemoveItemAtURL">The URL indicating the file or directory that the file manager is attempting to delete.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSURL shouldRemoveItemAtURL);
        
        /// <summary>
        /// Asks the delegate whether the item at the specified path should be deleted.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to remove the file or directory.</param>
        /// <param name="shouldRemoveItemAtPath">The path to the file or directory that the file manager is attempting to delete.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, string shouldRemoveItemAtPath);
        
        /// <summary>
        /// Asks the delegate if the operation should continue after an error occurs while removing the item at the specified URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to remove the item.</param>
        /// <param name="shouldProceedAfterError">The error that occurred while attempting to remove the item at URL.</param>
        /// <param name="removingItemAtURL">The URL for the file or directory that the file manager tried to delete.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, NSURL removingItemAtURL);
        
        /// <summary>
        /// Asks the delegate if the operation should continue after an error occurs while removing the item at the specified path.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to remove the item.</param>
        /// <param name="shouldProceedAfterError">The error that occurred during the attempt to copy.</param>
        /// <param name="removingItemAtPath">The path for the file or directory that the file manager tried to delete.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, string removingItemAtPath);
        
        /// <summary>
        /// Asks the delegate if a hard link should be created between the items at the two URLs.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to create the link.</param>
        /// <param name="shouldLinkItemAtURL">The URL identifying the new hard link to be created.</param>
        /// <param name="toURL">The URL identifying the destination of the link.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSURL shouldLinkItemAtURL, NSURL toURL, int NAME_YOUR_PARAMS = 0);
        
        /// <summary>
        /// Asks the delegate if a hard link should be created between the items at the two paths.
        /// </summary>
        /// <param name="fileManager">The file manager object that is attempting to create the link.</param>
        /// <param name="shouldLinkItemAtPath">The path or a file or directory that fileManager is about to attempt to link.</param>
        /// <param name="toPath">The path or a file or directory to which fileManager is about to attempt to link.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, string shouldLinkItemAtPath, string toPath, int NAME_YOUR_PARAMS = 0);
        
        /// <summary>
        /// Asks the delegate if the operation should continue after an error occurs while linking to the item at the specified URL.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to create the link.</param>
        /// <param name="shouldProceedAfterError">The error that occurred during the link attempt.</param>
        /// <param name="linkingItemAtURL">The URL of the attempted link location.</param>
        /// <param name="toURL">The URL of the file or directory that was the destination of the hard link.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(4)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, NSURL linkingItemAtURL, NSURL toURL, int NAME_YOUR_PARAMS = 0);
        
        /// <summary>
        /// Asks the delegate if the operation should continue after an error occurs while linking to the item at the specified path.
        /// </summary>
        /// <param name="fileManager">The file manager object that attempted to create the link.</param>
        /// <param name="shouldProceedAfterError">The error that occurred during the link attempt.</param>
        /// <param name="linkingItemAtPath">The path to the attempted link location.</param>
        /// <param name="toPath">The path to the file or directory that was the destination of the hard link.</param>
        /// <param name="NAME_YOUR_PARAMS">DO NOT USE THIS PARAMETER - Instead make sure to name the parameters you're using.</param>
        //[iOSVersion(2)]
        //[Export("fileManager")]
        //[InheritOptional]
        //[IgnoreParameter("NAME_YOUR_PARAMS")]
        //bool FileManager(NSFileManager fileManager, NSError shouldProceedAfterError, string linkingItemAtPath, string toPath, int NAME_YOUR_PARAMS = 0);
    }
}
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback