One Logo Pool Ball
X
Github
Discord

System

UIKit · IOS API REFERENCE

UIDocument

class · iOS 5.0+ · SDK 27.1

nonisolated class UIDocument

Members (41)

get · iOS 8.0+

userActivityURLKey

TypeScript
static get userActivityURLKey(): string
Swift declaration
class let userActivityURLKey: String
get · iOS 26.0+

didMoveToWritableLocationNotification

TypeScript
static get didMoveToWritableLocationNotification(): _Foundation_NSNotification_Name
Swift declaration
nonisolated class let didMoveToWritableLocationNotification: NSNotification.Name
get · iOS 26.0+

didMoveToWritableLocationOldURLKey

TypeScript
static get didMoveToWritableLocationOldURLKey(): string
Swift declaration
class let didMoveToWritableLocationOldURLKey: String
get · iOS 5.0+

stateChangedNotification

TypeScript
static get stateChangedNotification(): _Foundation_NSNotification_Name
Swift declaration
nonisolated class let stateChangedNotification: NSNotification.Name
method · iOS 5.0+

autosave

TypeScript
autosave(completionHandler?: (((arg0: boolean) => void)) | null): void
Swift declaration
func autosave() async -> Bool
method · iOS 5.0+

changeCountToken

TypeScript
changeCountToken(saveOperation: UIDocument_SaveOperation): unknown
Swift declaration
func changeCountToken(for saveOperation: UIDocument.SaveOperation) -> Any
method · iOS 5.0+

close

TypeScript
close(completionHandler?: (((arg0: boolean) => void)) | null): void
Swift declaration
func close() async -> Bool
method · iOS 5.0+

contents

TypeScript
contents(typeName: string): unknown
Swift declaration
func contents(forType typeName: String) throws -> Any
method · iOS 5.0+

disableEditing

TypeScript
disableEditing(): void
Swift declaration
func disableEditing()
method · iOS 5.0+

enableEditing

TypeScript
enableEditing(): void
Swift declaration
func enableEditing()
method · iOS 5.0+

fileAttributesToWrite

TypeScript
fileAttributesToWrite(url: string, saveOperation: UIDocument_SaveOperation): NativeMap<unknown, unknown>
Swift declaration
func fileAttributesToWrite(to url: URL, for saveOperation: UIDocument.SaveOperation) throws -> [AnyHashable : Any]
method · iOS 5.0+

fileNameExtension

TypeScript
fileNameExtension(typeName: (string) | null, saveOperation: UIDocument_SaveOperation): string
Swift declaration
func fileNameExtension(forType typeName: String?, saveOperation: UIDocument.SaveOperation) -> String
method · iOS 5.0+

finishedHandlingError

TypeScript
finishedHandlingError(error: NativeError, recovered: boolean): void
Swift declaration
func finishedHandlingError(_ error: any Error, recovered: Bool)
method · iOS 5.0+

handleError

TypeScript
handleError(error: NativeError, userInteractionPermitted: boolean): void
Swift declaration
func handleError(_ error: any Error, userInteractionPermitted: Bool)
init · iOS 5.0+

init

TypeScript
static init(url: string): UIDocument
Swift declaration
init(fileURL url: URL)
method · iOS 5.0+

load

TypeScript
load(contents: unknown, typeName?: (string) | null): void
Swift declaration
func load(fromContents contents: Any, ofType typeName: String?) throws
method · iOS 5.0+

open

TypeScript
open(completionHandler?: (((arg0: boolean) => void)) | null): void
Swift declaration
func open() async -> Bool
method · iOS 5.0+

performAsynchronousFileAccess

TypeScript
performAsynchronousFileAccess(block: (() => void)): void
Swift declaration
func performAsynchronousFileAccess(_ block: @escaping () -> Void)
method · iOS 5.0+

read

TypeScript
read(url: string): void
Swift declaration
func read(from url: URL) throws
method · iOS 8.0+

restoreUserActivityState

TypeScript
restoreUserActivityState(userActivity: _Foundation_NSUserActivity): void
Swift declaration
func restoreUserActivityState(_ userActivity: NSUserActivity)
method · iOS 5.0+

revert

TypeScript
revert(url: string, completionHandler?: (((arg0: boolean) => void)) | null): void
Swift declaration
func revert(toContentsOf url: URL) async -> Bool
method · iOS 5.0+

save

TypeScript
save(url: string, saveOperation: UIDocument_SaveOperation, completionHandler?: (((arg0: boolean) => void)) | null): void
Swift declaration
func save(to url: URL, for saveOperation: UIDocument.SaveOperation) async -> Bool
method · iOS 5.0+

updateChangeCount

TypeScript
updateChangeCount(change: UIDocument_ChangeKind): void
Swift declaration
func updateChangeCount(_ change: UIDocument.ChangeKind)
method · iOS 5.0+

updateChangeCount

TypeScript
updateChangeCountWithTokenFor(changeCountToken: unknown, saveOperation: UIDocument_SaveOperation): void
Swift declaration
func updateChangeCount(withToken changeCountToken: Any, for saveOperation: UIDocument.SaveOperation)
method · iOS 8.0+

updateUserActivityState

TypeScript
updateUserActivityState(userActivity: _Foundation_NSUserActivity): void
Swift declaration
func updateUserActivityState(_ userActivity: NSUserActivity)
method · iOS 5.0+

userInteractionNoLongerPermitted

TypeScript
userInteractionNoLongerPermitted(error: NativeError): void
Swift declaration
func userInteractionNoLongerPermitted(forError error: any Error)
method · iOS 5.0+

writeContents

TypeScript
writeContentsAndAttributesSafelyToFor(contents: unknown, additionalFileAttributes: (NativeMap<unknown, unknown>) | null, url: string, saveOperation: UIDocument_SaveOperation): void
Swift declaration
func writeContents(_ contents: Any, andAttributes additionalFileAttributes: [AnyHashable : Any]? = nil, safelyTo url: URL, for saveOperation: UIDocument.SaveOperation) throws
method · iOS 5.0+

writeContents

TypeScript
writeContentsToForOriginalContentsURL(contents: unknown, url: string, saveOperation: UIDocument_SaveOperation, originalContentsURL?: (string) | null): void
Swift declaration
func writeContents(_ contents: Any, to url: URL, for saveOperation: UIDocument.SaveOperation, originalContentsURL: URL?) throws
get · iOS 5.0+

documentState

TypeScript
get documentState(): UIDocument_State
Swift declaration
var documentState: UIDocument.State { get }
get · iOS 5.0+

fileModificationDate

TypeScript
get fileModificationDate(): (globalThis.Date) | null
Swift declaration
var fileModificationDate: Date? { get set }
set · iOS 5.0+

fileModificationDate

TypeScript
set fileModificationDate(value: (globalThis.Date) | null)
Swift declaration
var fileModificationDate: Date? { get set }
get · iOS 5.0+

fileType

TypeScript
get fileType(): (string) | null
Swift declaration
var fileType: String? { get }
get · iOS 5.0+

fileURL

TypeScript
get fileURL(): string
Swift declaration
var fileURL: URL { get }
get · iOS 5.0+

hasUnsavedChanges

TypeScript
get hasUnsavedChanges(): boolean
Swift declaration
var hasUnsavedChanges: Bool { get }
get · iOS 5.0+

localizedName

TypeScript
get localizedName(): string
Swift declaration
var localizedName: String { get }
get · iOS 9.0+

progress

TypeScript
get progress(): (_Foundation_Progress) | null
Swift declaration
var progress: Progress? { get }
get · iOS 5.0+

savingFileType

TypeScript
get savingFileType(): (string) | null
Swift declaration
var savingFileType: String? { get }
get · iOS 5.0+

undoManager

TypeScript
get undoManager(): (_Foundation_UndoManager) | null
Swift declaration
var undoManager: UndoManager! { get set }
set · iOS 5.0+

undoManager

TypeScript
set undoManager(value: (_Foundation_UndoManager) | null)
Swift declaration
var undoManager: UndoManager! { get set }
get · iOS 8.0+

userActivity

TypeScript
get userActivity(): (_Foundation_NSUserActivity) | null
Swift declaration
var userActivity: NSUserActivity? { get set }
set · iOS 8.0+

userActivity

TypeScript
set userActivity(value: (_Foundation_NSUserActivity) | null)
Swift declaration
var userActivity: NSUserActivity? { get set }

Skipped declarations

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

UIDocument.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All UIKit types →