One Logo Pool Ball
X
Github
Discord

System

FileProvider · IOS API REFERENCE

NSFileProviderManager

class · iOS 11.0+ · SDK 27.1

class NSFileProviderManager

Members (31)

static · iOS 11.0+

add

TypeScript
static add(domain: NSFileProviderDomain, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
class func add(_ domain: NSFileProviderDomain) async throws
static · iOS 11.0+

getDomainsWithCompletionHandler

TypeScript
static getDomainsWithCompletionHandler(completionHandler: ((arg0: Array<NSFileProviderDomain>, arg1: (NativeError) | null) => void)): void
Swift declaration
class func domains() async throws -> [NSFileProviderDomain]
static · iOS 16.0+

getIdentifierForUserVisibleFile

TypeScript
static getIdentifierForUserVisibleFile(url: string, completionHandler: ((arg0: (NSFileProviderItemIdentifier) | null, arg1: (NSFileProviderDomainIdentifier) | null, arg2: (NativeError) | null) => void)): void
Swift declaration
class func identifierForUserVisibleFile(at url: URL) async throws -> (NSFileProviderItemIdentifier, NSFileProviderDomainIdentifier)
static · iOS 16.0+

import

TypeScript
static import(domain: NSFileProviderDomain, url: string, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
class func `import`(_ domain: NSFileProviderDomain, fromDirectoryAt url: URL) async throws
init · iOS 11.0+

init

TypeScript
static init(domain: NSFileProviderDomain): (NSFileProviderManager) | null
Swift declaration
convenience init?(for domain: NSFileProviderDomain)
static · iOS 11.0+

placeholderURL

TypeScript
static placeholderURL(url: string): string
Swift declaration
class func placeholderURL(for url: URL) -> URL
static · iOS 11.0+

removeAllDomains

TypeScript
static removeAllDomains(completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
class func removeAllDomains() async throws
static · iOS 11.0+

remove

TypeScript
static removeCompletionHandler(domain: NSFileProviderDomain, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
class func remove(_ domain: NSFileProviderDomain) async throws
static · iOS 16.0+

remove

TypeScript
static removeModeCompletionHandler(domain: NSFileProviderDomain, mode: NSFileProviderManager_DomainRemovalMode, completionHandler: ((arg0: (string) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func remove(_ domain: NSFileProviderDomain, mode: NSFileProviderManager.DomainRemovalMode) async throws -> URL?
static · iOS 11.0+

writePlaceholder

TypeScript
static writePlaceholder(placeholderURL: string, metadata: SDKHandle): void
Swift declaration
class func writePlaceholder(at placeholderURL: URL, withMetadata metadata: NSFileProviderItem) throws
get · iOS 11.0+

default

TypeScript
static get default(): NSFileProviderManager
Swift declaration
class var `default`: NSFileProviderManager { get }
method · iOS 16.0+

enumeratorForMaterializedItems

TypeScript
enumeratorForMaterializedItems(): SDKHandle
Swift declaration
func enumeratorForMaterializedItems() -> any NSFileProviderEnumerator
method · iOS 16.0+

enumeratorForPendingItems

TypeScript
enumeratorForPendingItems(): SDKHandle
Swift declaration
func enumeratorForPendingItems() -> any NSFileProviderPendingSetEnumerator
method · iOS 16.0+

evictItem

TypeScript
evictItem(itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func evictItem(identifier itemIdentifier: NSFileProviderItemIdentifier) async throws
method · iOS 16.0+

getService

TypeScript
getService(serviceName: _Foundation_NSFileProviderServiceName, itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (_Foundation_NSFileProviderService) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func service(named serviceName: NSFileProviderServiceName, for itemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderService?
method · iOS 16.0+

getUserVisibleURL

TypeScript
getUserVisibleURL(itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (string) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func getUserVisibleURL(for itemIdentifier: NSFileProviderItemIdentifier) async throws -> URL
method · iOS 16.0+

globalProgress

TypeScript
globalProgress(kind: _Foundation_Progress_FileOperationKind): _Foundation_Progress
Swift declaration
func globalProgress(for kind: Progress.FileOperationKind) -> Progress
method · iOS 16.0+

listAvailableTestingOperations

TypeScript
listAvailableTestingOperations(): Array<SDKHandle>
Swift declaration
func listAvailableTestingOperations() throws -> [any NSFileProviderTestingOperation]
method · iOS 11.0+

register

TypeScript
register(task: _Foundation_URLSessionTask, identifier: NSFileProviderItemIdentifier, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func register(_ task: URLSessionTask, forItemWithIdentifier identifier: NSFileProviderItemIdentifier) async throws
method · iOS 16.0+

reimportItems

TypeScript
reimportItems(itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func reimportItems(below itemIdentifier: NSFileProviderItemIdentifier) async throws
method · iOS 16.0+

requestModification

TypeScript
requestModification(fields: NSFileProviderItemFields, itemIdentifier: NSFileProviderItemIdentifier, options: NSFileProviderModifyItemOptions, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func requestModification(of fields: NSFileProviderItemFields, forItemWithIdentifier itemIdentifier: NSFileProviderItemIdentifier, options: NSFileProviderModifyItemOptions = []) async throws
method · iOS 16.0+

run

TypeScript
run(operations: Array<SDKHandle>): NativeMap<unknown, NativeError>
Swift declaration
func run(_ operations: [any NSFileProviderTestingOperation]) throws -> [AnyHashable : any Error]
method · iOS 11.0+

signalEnumerator

TypeScript
signalEnumerator(containerItemIdentifier: NSFileProviderItemIdentifier, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func signalEnumerator(for containerItemIdentifier: NSFileProviderItemIdentifier) async throws
method · iOS 16.0+

signalErrorResolved

TypeScript
signalErrorResolved(error: NativeError, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func signalErrorResolved(_ error: any Error) async throws
method · iOS 16.0+

temporaryDirectoryURL

TypeScript
temporaryDirectoryURL(): string
Swift declaration
func temporaryDirectoryURL() throws -> URL
method · iOS 16.0+

waitForChanges

TypeScript
waitForChanges(itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func waitForChanges(below itemIdentifier: NSFileProviderItemIdentifier) async throws
method · iOS 16.0+

waitForStabilization

TypeScript
waitForStabilization(completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func waitForStabilization() async throws
get · iOS 11.0+

documentStorageURL

TypeScript
get documentStorageURL(): string
Swift declaration
var documentStorageURL: URL { get }
get · iOS 11.0+

providerIdentifier

TypeScript
get providerIdentifier(): string
Swift declaration
var providerIdentifier: String { get }
method · iOS 16.0+

requestDownloadForItem

TypeScript
requestDownloadForItemWithIdentifierRequestedRangeCompletionHandler(itemIdentifier: NSFileProviderItemIdentifier, requestedRange: (SDKHandle) | null, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func requestDownloadForItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, requestedRange: NSRange? = nil, completionHandler: @escaping ((any Error)?) -> Void)
method · iOS 16.0+

requestDownloadForItem

TypeScript
requestDownloadForItemWithIdentifierRequestedRange(itemIdentifier: NSFileProviderItemIdentifier, requestedRange?: (SDKHandle) | null): Promise<void>
Swift declaration
func requestDownloadForItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, requestedRange: NSRange? = nil) async throws

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

NSFileProviderManager.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All FileProvider types →