FileManager

default

static get default(): FileManager

class var `default`: FileManager { get }

url

urlForInAppropriateForCreate(directory: FileManager_SearchPathDirectory, domain: FileManager_SearchPathDomainMask, url: (string) | null, shouldCreate: boolean): string

func url(for directory: FileManager.SearchPathDirectory, in domain: FileManager.SearchPathDomainMask, appropriateFor url: URL?, create shouldCreate: Bool) throws -> URL

url

urlForPublishingUbiquitousItemAtExpiration(url: string): { $ret: string; $out: { "outDate": (NSDate) | null } }

func url(forPublishingUbiquitousItemAt url: URL, expiration outDate: AutoreleasingUnsafeMutablePointer<NSDate?>?) throws -> URL

Omit the output parameters from the call. The result contains $ret and $out, with outDate inside $out.

url

urlForUbiquityContainerIdentifier(containerIdentifier?: (string) | null): (string) | null

func url(forUbiquityContainerIdentifier containerIdentifier: String?) -> URL?

urls

urls(directory: FileManager_SearchPathDirectory, domainMask: FileManager_SearchPathDomainMask): Array<string>

func urls(for directory: FileManager.SearchPathDirectory, in domainMask: FileManager.SearchPathDomainMask) -> [URL]

attributesOfFileSystem

attributesOfFileSystem(path: string): NativeMap<FileAttributeKey, unknown>

func attributesOfFileSystem(forPath path: String) throws -> [FileAttributeKey : Any]

attributesOfItem

attributesOfItem(path: string): NativeMap<FileAttributeKey, unknown>

func attributesOfItem(atPath path: String) throws -> [FileAttributeKey : Any]

changeCurrentDirectoryPath

changeCurrentDirectoryPath(path: string): boolean

func changeCurrentDirectoryPath(_ path: String) -> Bool

componentsToDisplay

componentsToDisplay(path: string): (Array<string>) | null

func componentsToDisplay(forPath path: String) -> [String]?

containerURL

containerURL(groupIdentifier: string): (string) | null

func containerURL(forSecurityApplicationGroupIdentifier groupIdentifier: String) -> URL?

contents

contents(path: string): (ArrayBuffer) | null

func contents(atPath path: String) -> Data?

contentsEqual

contentsEqual(path1: string, path2: string): boolean

func contentsEqual(atPath path1: String, andPath path2: String) -> Bool

contentsOfDirectory

contentsOfDirectoryAtPath(path: string): Array<string>

func contentsOfDirectory(atPath path: String) throws -> [String]

contentsOfDirectory

contentsOfDirectoryAtIncludingPropertiesForKeysOptions(url: string, keys?: (Array<URLResourceKey>) | null, mask?: FileManager_DirectoryEnumerationOptions): Array<string>

func contentsOfDirectory(at url: URL, includingPropertiesForKeys keys: [URLResourceKey]?, options mask: FileManager.DirectoryEnumerationOptions = []) throws -> [URL]

copyItem

copyItemAtPathToPath(srcPath: string, dstPath: string): void

func copyItem(atPath srcPath: String, toPath dstPath: String) throws

copyItem

copyItemAtTo(srcURL: string, dstURL: string): void

func copyItem(at srcURL: URL, to dstURL: URL) throws

createDirectory

createDirectoryAtPathWithIntermediateDirectoriesAttributes(path: string, createIntermediates: boolean, attributes?: (NativeMap<FileAttributeKey, unknown>) | null): void

func createDirectory(atPath path: String, withIntermediateDirectories createIntermediates: Bool, attributes: [FileAttributeKey : Any]? = nil) throws

createDirectory

createDirectoryAtWithIntermediateDirectoriesAttributes(url: string, createIntermediates: boolean, attributes?: (NativeMap<FileAttributeKey, unknown>) | null): void

func createDirectory(at url: URL, withIntermediateDirectories createIntermediates: Bool, attributes: [FileAttributeKey : Any]? = nil) throws

createFile

createFile(path: string, data?: (ArrayBuffer) | null, attr?: (NativeMap<FileAttributeKey, unknown>) | null): boolean

func createFile(atPath path: String, contents data: Data?, attributes attr: [FileAttributeKey : Any]? = nil) -> Bool

createSymbolicLink

createSymbolicLinkAtPathWithDestinationPath(path: string, destPath: string): void

func createSymbolicLink(atPath path: String, withDestinationPath destPath: String) throws

createSymbolicLink

createSymbolicLinkAtWithDestinationURL(url: string, destURL: string): void

func createSymbolicLink(at url: URL, withDestinationURL destURL: URL) throws

destinationOfSymbolicLink

destinationOfSymbolicLink(path: string): string

func destinationOfSymbolicLink(atPath path: String) throws -> String

displayName

displayName(path: string): string

func displayName(atPath path: String) -> String

enumerator

enumeratorAtPath(path: string): (FileManager_DirectoryEnumerator) | null

func enumerator(atPath path: String) -> FileManager.DirectoryEnumerator?

evictUbiquitousItem

evictUbiquitousItem(url: string): void

func evictUbiquitousItem(at url: URL) throws

fetchLatestRemoteVersionOfItem

fetchLatestRemoteVersionOfItem(url: string, completionHandler: ((arg0: (NSFileVersion) | null, arg1: (NativeError) | null) => void)): void

func fetchLatestRemoteVersionOfItem(at url: URL) async throws -> NSFileVersion

fileExists

fileExistsAtPath(path: string): boolean

func fileExists(atPath path: String) -> Bool

fileExists

fileExistsAtPathIsDirectory(path: string): { $ret: boolean; $out: { "isDirectory": boolean } }

func fileExists(atPath path: String, isDirectory: UnsafeMutablePointer<ObjCBool>?) -> Bool

Omit the output parameters from the call. The result contains $ret and $out, with isDirectory inside $out.

fileSystemRepresentation

fileSystemRepresentation(path: string): SDKHandle

func fileSystemRepresentation(withPath path: String) -> UnsafePointer<CChar>

getFileProviderServicesForItem

getFileProviderServicesForItem(url: string, completionHandler: ((arg0: (NativeMap<NSFileProviderServiceName, NSFileProviderService>) | null, arg1: (NativeError) | null) => void)): void

func fileProviderServicesForItem(at url: URL) async throws -> [NSFileProviderServiceName : NSFileProviderService]

getRelationship

getRelationshipOfInToItemAt(outRelationship: SDKHandle, directory: FileManager_SearchPathDirectory, domainMask: FileManager_SearchPathDomainMask, url: string): void

func getRelationship(_ outRelationship: UnsafeMutablePointer<FileManager.URLRelationship>, of directory: FileManager.SearchPathDirectory, in domainMask: FileManager.SearchPathDomainMask, toItemAt url: URL) throws

getRelationship

getRelationshipOfDirectoryAtToItemAt(outRelationship: SDKHandle, directoryURL: string, otherURL: string): void

func getRelationship(_ outRelationship: UnsafeMutablePointer<FileManager.URLRelationship>, ofDirectoryAt directoryURL: URL, toItemAt otherURL: URL) throws

init

static init(): FileManager

init()

isDeletableFile

isDeletableFile(path: string): boolean

func isDeletableFile(atPath path: String) -> Bool

isExecutableFile

isExecutableFile(path: string): boolean

func isExecutableFile(atPath path: String) -> Bool

isReadableFile

isReadableFile(path: string): boolean

func isReadableFile(atPath path: String) -> Bool

isUbiquitousItem

isUbiquitousItem(url: string): boolean

func isUbiquitousItem(at url: URL) -> Bool

isWritableFile

isWritableFile(path: string): boolean

func isWritableFile(atPath path: String) -> Bool

linkItem

linkItemAtPathToPath(srcPath: string, dstPath: string): void

func linkItem(atPath srcPath: String, toPath dstPath: String) throws

linkItem

linkItemAtTo(srcURL: string, dstURL: string): void

func linkItem(at srcURL: URL, to dstURL: URL) throws

mountedVolumeURLs

mountedVolumeURLs(propertyKeys?: (Array<URLResourceKey>) | null, options?: FileManager_VolumeEnumerationOptions): (Array<string>) | null

func mountedVolumeURLs(includingResourceValuesForKeys propertyKeys: [URLResourceKey]?, options: FileManager.VolumeEnumerationOptions = []) -> [URL]?

moveItem

moveItemAtPathToPath(srcPath: string, dstPath: string): void

func moveItem(atPath srcPath: String, toPath dstPath: String) throws

moveItem

moveItemAtTo(srcURL: string, dstURL: string): void

func moveItem(at srcURL: URL, to dstURL: URL) throws

pauseSyncForUbiquitousItem

pauseSyncForUbiquitousItem(url: string, completionHandler: ((arg0: (NativeError) | null) => void)): void

func pauseSyncForUbiquitousItem(at url: URL) async throws

removeItem

removeItemAtPath(path: string): void

func removeItem(atPath path: String) throws

removeItem

removeItemAt(URL: string): void

func removeItem(at URL: URL) throws

replaceItem

replaceItem(originalItemURL: string, newItemURL: string, backupItemName?: (string) | null, options?: FileManager_ItemReplacementOptions): { $ret: null; $out: { "resultingURL": (NSURL) | null } }

func replaceItem(at originalItemURL: URL, withItemAt newItemURL: URL, backupItemName: String?, options: FileManager.ItemReplacementOptions = [], resultingItemURL resultingURL: AutoreleasingUnsafeMutablePointer<NSURL?>?) throws

Omit the output parameters from the call. The result contains $ret and $out, with resultingURL inside $out.

resumeSyncForUbiquitousItem

resumeSyncForUbiquitousItem(url: string, behavior: NSFileManagerResumeSyncBehavior, completionHandler: ((arg0: (NativeError) | null) => void)): void

func resumeSyncForUbiquitousItem(at url: URL, with behavior: NSFileManagerResumeSyncBehavior) async throws

setAttributes

setAttributes(attributes: NativeMap<FileAttributeKey, unknown>, path: string): void

func setAttributes(_ attributes: [FileAttributeKey : Any], ofItemAtPath path: String) throws

setUbiquitous

setUbiquitous(flag: boolean, url: string, destinationURL: string): void

func setUbiquitous(_ flag: Bool, itemAt url: URL, destinationURL: URL) throws

startDownloadingUbiquitousItem

startDownloadingUbiquitousItem(url: string): void

func startDownloadingUbiquitousItem(at url: URL) throws

string

string(str: SDKHandle, len: number): string

func string(withFileSystemRepresentation str: UnsafePointer<CChar>, length len: Int) -> String

subpaths

subpaths(path: string): (Array<string>) | null

func subpaths(atPath path: String) -> [String]?

subpathsOfDirectory

subpathsOfDirectory(path: string): Array<string>

func subpathsOfDirectory(atPath path: String) throws -> [String]

trashItem

trashItem(url: string): { $ret: null; $out: { "outResultingURL": (NSURL) | null } }

func trashItem(at url: URL, resultingItemURL outResultingURL: AutoreleasingUnsafeMutablePointer<NSURL?>?) throws

Omit the output parameters from the call. The result contains $ret and $out, with outResultingURL inside $out.

uploadLocalVersionOfUbiquitousItem

uploadLocalVersionOfUbiquitousItem(url: string, conflictResolutionPolicy: NSFileManagerUploadLocalVersionConflictPolicy, completionHandler: ((arg0: (NSFileVersion) | null, arg1: (NativeError) | null) => void)): void

func uploadLocalVersionOfUbiquitousItem(at url: URL, withConflictResolutionPolicy conflictResolutionPolicy: NSFileManagerUploadLocalVersionConflictPolicy) async throws -> NSFileVersion

currentDirectoryPath

get currentDirectoryPath(): string

var currentDirectoryPath: String { get }

delegate

get delegate(): (SDKHandle) | null

unowned(unsafe) var delegate: (any FileManagerDelegate)? { get set }

delegate

set delegate(value: (Implements<FileManagerDelegate> | SDKHandle) | null)

unowned(unsafe) var delegate: (any FileManagerDelegate)? { get set }

temporaryDirectory

get temporaryDirectory(): string

var temporaryDirectory: URL { get }

ubiquityIdentityToken

get ubiquityIdentityToken(): ((SDKHandle) & (SDKHandle) & (SDKHandle)) | null

@NSCopying var ubiquityIdentityToken: (any NSCoding & NSCopying & NSObjectProtocol)? { get }

enumerator

enumeratorAtIncludingPropertiesForKeysOptions(url: string, keys?: (Array<URLResourceKey>) | null, mask?: FileManager_DirectoryEnumerationOptions): (FileManager_DirectoryEnumerator) | null

@nonobjc func enumerator(at url: URL, includingPropertiesForKeys keys: [URLResourceKey]?, options mask: FileManager.DirectoryEnumerationOptions = [], errorHandler handler: ((URL, any Error) -> Bool)? = nil) -> FileManager.DirectoryEnumerator?

Returns a directory enumerator object that can be used to perform a deep enumeration of the directory at the specified URL. Because the enumeration is deep — that is, it lists the contents of all subdirectories — this enumerator object is useful for performing actions that involve large file-system subtrees. If the method is passed a directory on which another file system is mounted (a mount point), it traverses the mount point. This method does not resolve symbolic links or mount points encountered in the enumeration process, nor does it recurse through them if they point to a directory. The ``FileManager/DirectoryEnumerator`` class has methods for skipping descendants of the existing path and for returning the number of levels deep the current object is in the directory hierarchy being enumerated (where the directory passed to this method is considered to be level 0). - Parameters: - url: The location of the directory for which you want an enumeration. This URL must not be a symbolic link that points to the desired directory. - keys: An array of keys that identify the properties that you want pre-fetched for each item in the enumeration. You may specify `nil`. - mask: Options for the enumeration. - handler: An optional error handler block for the file manager to call when an error occurs. The handler block should return `true` if you want the enumeration to continue or `false` if you want it to stop. - Returns: A directory enumerator object that enumerates the contents of the directory at `url`. If `url` is a filename, the method returns an enumerator object that enumerates no files — the first call to `nextObject()` returns `nil`.

replaceItemAt

replaceItemAt(originalItemURL: string, newItemURL: string, backupItemName?: (string) | null, options?: FileManager_ItemReplacementOptions): (string) | null

func replaceItemAt(_ originalItemURL: URL, withItemAt newItemURL: URL, backupItemName: String? = nil, options: FileManager.ItemReplacementOptions = []) throws -> URL?

Replaces the contents of the item at the specified URL in a manner that ensures no data loss occurs. By default, the creation date, permissions, Finder label and color, and Spotlight comments of the original item are preserved on the new item. You can configure which metadata is preserved using the `options` parameter. This method works only when the `originalItemURL` and `newItemURL` parameters are located on the same volume. Attempting to call this method by passing parameters that have locations on different volumes results in an error. - Parameters: - originalItemURL: The item containing the content you want to replace. - newItemURL: The item containing the new content for `originalItemURL`. It is recommended that you put this item in a temporary directory as provided by the OS. - backupItemName: If provided, the name used to create a backup of the original item. The backup is placed in the same directory as the original item. - options: The options to use during the replacement. Typically, you pass ``FileManager/ItemReplacementOptions/usingNewMetadataOnly``. - Returns: The URL of the new item. If no new file system object is required, the URL object may be the same passed to `originalItemURL`.

replaceItemAtURL

replaceItemAtURL(originalItemURL: NSURL, newItemURL: NSURL, backupItemName?: (string) | null, options?: FileManager_ItemReplacementOptions): (NSURL) | null

func replaceItemAtURL(originalItemURL: NSURL, withItemAtURL newItemURL: NSURL, backupItemName: String? = nil, options: FileManager.ItemReplacementOptions = []) throws -> NSURL?

Replaces the contents of the item at the specified URL in a manner that ensures no data loss occurs. @DeprecationSummary { Use ``replaceItemAt(_:withItemAt:backupItemName:options:)-4210g`` instead. } - Parameters: - originalItemURL: The item containing the content you want to replace. - newItemURL: The item containing the new content for `originalItemURL`. - backupItemName: If provided, the name used to create a backup of the original item. - options: The options to use during the replacement. - Returns: The URL of the new item, or `nil`.