One Logo Pool Ball
X
Github
Discord

System

FileProvider · IOS API REFERENCE

NSFileProviderExtension

class · iOS 8.0+ · SDK 27.1

class NSFileProviderExtension

Members (26)

static · iOS 8.0+ · Deprecated in iOS 11.0

placeholderURL

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

writePlaceholder

TypeScript
static writePlaceholder(placeholderURL: string, metadata: NativeMap<_Foundation_URLResourceKey, unknown>): void
Swift declaration
class func writePlaceholder(at placeholderURL: URL, withMetadata metadata: [URLResourceKey : Any]) throws
method · iOS 8.0+

urlForItem

TypeScript
urlForItem(identifier: NSFileProviderItemIdentifier): (string) | null
Swift declaration
func urlForItem(withPersistentIdentifier identifier: NSFileProviderItemIdentifier) -> URL?
method · iOS 11.0+

createDirectory

TypeScript
createDirectory(directoryName: string, parentItemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func createDirectory(withName directoryName: String, inParentItemIdentifier parentItemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
method · iOS 11.0+

deleteItem

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

enumerator

TypeScript
enumerator(containerItemIdentifier: NSFileProviderItemIdentifier): SDKHandle
Swift declaration
func enumerator(for containerItemIdentifier: NSFileProviderItemIdentifier) throws -> any NSFileProviderEnumerator
method · iOS 11.0+

fetchThumbnails

TypeScript
fetchThumbnails(itemIdentifiers: Array<NSFileProviderItemIdentifier>, size: { width: number; height: number }, perThumbnailCompletionHandler: ((arg0: NSFileProviderItemIdentifier, arg1: (ArrayBuffer) | null, arg2: (NativeError) | null) => void), completionHandler: ((arg0: (NativeError) | null) => void)): _Foundation_Progress
Swift declaration
func fetchThumbnails(for itemIdentifiers: [NSFileProviderItemIdentifier], requestedSize size: CGSize, perThumbnailCompletionHandler: @escaping (NSFileProviderItemIdentifier, Data?, (any Error)?) -> Void, completionHandler: @escaping ((any Error)?) -> Void) -> Progress
method · iOS 11.0+

importDocument

TypeScript
importDocument(fileURL: string, parentItemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func importDocument(at fileURL: URL, toParentItemIdentifier parentItemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
init

init

TypeScript
static init(): NSFileProviderExtension
Swift declaration
init()
method · iOS 8.0+

itemChanged

TypeScript
itemChanged(url: string): void
Swift declaration
func itemChanged(at url: URL)
method · iOS 11.0+

item

TypeScript
item(identifier: NSFileProviderItemIdentifier): SDKHandle
Swift declaration
func item(for identifier: NSFileProviderItemIdentifier) throws -> NSFileProviderItem
method · iOS 8.0+

persistentIdentifierForItem

TypeScript
persistentIdentifierForItem(url: string): (NSFileProviderItemIdentifier) | null
Swift declaration
func persistentIdentifierForItem(at url: URL) -> NSFileProviderItemIdentifier?
method · iOS 8.0+

providePlaceholder

TypeScript
providePlaceholder(url: string, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func providePlaceholder(at url: URL) async throws
method · iOS 11.0+

renameItem

TypeScript
renameItem(itemIdentifier: NSFileProviderItemIdentifier, itemName: string, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func renameItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, toName itemName: String) async throws -> NSFileProviderItem
method · iOS 11.0+

reparentItem

TypeScript
reparentItem(itemIdentifier: NSFileProviderItemIdentifier, parentItemIdentifier: NSFileProviderItemIdentifier, newName: (string) | null, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func reparentItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, toParentItemWithIdentifier parentItemIdentifier: NSFileProviderItemIdentifier, newName: String?) async throws -> NSFileProviderItem
method · iOS 11.0+

setFavoriteRank

TypeScript
setFavoriteRank(favoriteRank: (_Foundation_NSNumber) | null, itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func setFavoriteRank(_ favoriteRank: NSNumber?, forItemIdentifier itemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
method · iOS 11.0+

setLastUsedDate

TypeScript
setLastUsedDate(lastUsedDate: (globalThis.Date) | null, itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func setLastUsedDate(_ lastUsedDate: Date?, forItemIdentifier itemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
method · iOS 11.0+

setTagData

TypeScript
setTagData(tagData: (ArrayBuffer) | null, itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func setTagData(_ tagData: Data?, forItemIdentifier itemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
method · iOS 8.0+

startProvidingItem

TypeScript
startProvidingItem(url: string, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func startProvidingItem(at url: URL) async throws
method · iOS 8.0+

stopProvidingItem

TypeScript
stopProvidingItem(url: string): void
Swift declaration
func stopProvidingItem(at url: URL)
method · iOS 11.0+

supportedServiceSources

TypeScript
supportedServiceSources(itemIdentifier: NSFileProviderItemIdentifier): Array<SDKHandle>
Swift declaration
func supportedServiceSources(for itemIdentifier: NSFileProviderItemIdentifier) throws -> [any NSFileProviderServiceSource]
method · iOS 11.0+

trashItem

TypeScript
trashItem(itemIdentifier: NSFileProviderItemIdentifier, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func trashItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier) async throws -> NSFileProviderItem
method · iOS 11.0+

untrashItem

TypeScript
untrashItem(itemIdentifier: NSFileProviderItemIdentifier, parentItemIdentifier: (NSFileProviderItemIdentifier) | null, completionHandler: ((arg0: (SDKHandle) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func untrashItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, toParentItemIdentifier parentItemIdentifier: NSFileProviderItemIdentifier?) async throws -> NSFileProviderItem
get · iOS 8.0+ · Deprecated in iOS 11.0

documentStorageURL

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

domain

TypeScript
get domain(): (NSFileProviderDomain) | null
Swift declaration
var domain: NSFileProviderDomain? { get }
get · iOS 8.0+ · Deprecated in iOS 11.0

providerIdentifier

TypeScript
get providerIdentifier(): string
Swift declaration
var providerIdentifier: String { get }

Skipped declarations

No declarations were skipped in this snapshot.

All FileProvider types →