fileprovider

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 21, 2024 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

An extension other apps use to access files and folders managed by your app and synced with a remote storage.

Apple Documentation

Index

Constants

This section is empty.

Variables

View Source
var FileProviderDomainClass = _FileProviderDomainClass{objc.GetClass("NSFileProviderDomain")}

The class instance for the FileProviderDomain class.

View Source
var FileProviderDomainVersionClass = _FileProviderDomainVersionClass{objc.GetClass("NSFileProviderDomainVersion")}

The class instance for the FileProviderDomainVersion class.

View Source
var FileProviderItemVersionClass = _FileProviderItemVersionClass{objc.GetClass("NSFileProviderItemVersion")}

The class instance for the FileProviderItemVersion class.

View Source
var FileProviderManagerClass = _FileProviderManagerClass{objc.GetClass("NSFileProviderManager")}

The class instance for the FileProviderManager class.

View Source
var FileProviderRequestClass = _FileProviderRequestClass{objc.GetClass("NSFileProviderRequest")}

The class instance for the FileProviderRequest class.

Functions

func FileProviderItemVersion_BeforeFirstSyncComponent

func FileProviderItemVersion_BeforeFirstSyncComponent() []byte

A Boolean value indicating that this version predates the version returned by the file provider extension. Full Topic

func FileProviderManager_AddDomainCompletionHandler

func FileProviderManager_AddDomainCompletionHandler(domain IFileProviderDomain, completionHandler func(error foundation.Error))

Adds a domain to the File Provider extension. Full Topic

func FileProviderManager_GetDomainsWithCompletionHandler

func FileProviderManager_GetDomainsWithCompletionHandler(completionHandler func(domains []FileProviderDomain, error foundation.Error))

Returns all of the File Provider extension's domains. Full Topic

func FileProviderManager_GetIdentifierForUserVisibleFileAtURLCompletionHandler

func FileProviderManager_GetIdentifierForUserVisibleFileAtURLCompletionHandler(url foundation.IURL, completionHandler func(itemIdentifier FileProviderItemIdentifier, domainIdentifier FileProviderDomainIdentifier, error foundation.Error))

Returns the identifier and domain for a user-visible URL. Full Topic

func FileProviderManager_ImportDomainFromDirectoryAtURLCompletionHandler

func FileProviderManager_ImportDomainFromDirectoryAtURLCompletionHandler(domain IFileProviderDomain, url foundation.IURL, completionHandler func(error foundation.Error))

Creates a new domain that takes ownership of on-disk data that your app previously managed without a file provider. Full Topic

func FileProviderManager_RemoveAllDomainsWithCompletionHandler

func FileProviderManager_RemoveAllDomainsWithCompletionHandler(completionHandler func(error foundation.Error))

Removes all domains from the File Provider extension. Full Topic

func FileProviderManager_RemoveDomainCompletionHandler

func FileProviderManager_RemoveDomainCompletionHandler(domain IFileProviderDomain, completionHandler func(error foundation.Error))

Removes a domain from the File Provider extension. Full Topic

func FileProviderManager_RemoveDomainModeCompletionHandler

func FileProviderManager_RemoveDomainModeCompletionHandler(domain IFileProviderDomain, mode FileProviderDomainRemovalMode, completionHandler func(preservedLocation foundation.URL, error foundation.Error))

Removes a domain from the File Provider extension using the specified options. Full Topic

Types

type FileProviderChangeObserverObject

type FileProviderChangeObserverObject struct {
	objc.Object
}

A concrete type for the PFileProviderChangeObserver protocol.

func (FileProviderChangeObserverObject) DidDeleteItemsWithIdentifiers

func (f_ FileProviderChangeObserverObject) DidDeleteItemsWithIdentifiers(deletedItemIdentifiers []FileProviderItemIdentifier)

Tells the observer that the specified items have been deleted. Full Topic

func (FileProviderChangeObserverObject) DidUpdateItems

func (f_ FileProviderChangeObserverObject) DidUpdateItems(updatedItems []objc.Object)

Tells the observer that the specified items have been updated. Full Topic

func (FileProviderChangeObserverObject) FinishEnumeratingChangesUpToSyncAnchorMoreComing

func (f_ FileProviderChangeObserverObject) FinishEnumeratingChangesUpToSyncAnchorMoreComing(anchor FileProviderSyncAnchor, moreComing bool)

Tells the observer that all of the changes have been enumerated up to the specified sync anchor. Full Topic

func (FileProviderChangeObserverObject) FinishEnumeratingWithError

func (f_ FileProviderChangeObserverObject) FinishEnumeratingWithError(error foundation.Error)

Tells the observer that an error occurred during change notification. Full Topic

func (FileProviderChangeObserverObject) HasDidDeleteItemsWithIdentifiers

func (f_ FileProviderChangeObserverObject) HasDidDeleteItemsWithIdentifiers() bool

func (FileProviderChangeObserverObject) HasDidUpdateItems

func (f_ FileProviderChangeObserverObject) HasDidUpdateItems() bool

func (FileProviderChangeObserverObject) HasFinishEnumeratingChangesUpToSyncAnchorMoreComing

func (f_ FileProviderChangeObserverObject) HasFinishEnumeratingChangesUpToSyncAnchorMoreComing() bool

func (FileProviderChangeObserverObject) HasFinishEnumeratingWithError

func (f_ FileProviderChangeObserverObject) HasFinishEnumeratingWithError() bool

func (FileProviderChangeObserverObject) HasSuggestedBatchSize

func (f_ FileProviderChangeObserverObject) HasSuggestedBatchSize() bool

func (FileProviderChangeObserverObject) SuggestedBatchSize

func (f_ FileProviderChangeObserverObject) SuggestedBatchSize() int

The batch size that the system recommends. Full Topic

type FileProviderCreateItemOptions

type FileProviderCreateItemOptions uint

Options for creating items. Full Topic

const (
	FileProviderCreateItemDeletionConflicted FileProviderCreateItemOptions = 2
	FileProviderCreateItemMayAlreadyExist    FileProviderCreateItemOptions = 1
)

type FileProviderCustomActionObject

type FileProviderCustomActionObject struct {
	objc.Object
}

A concrete type for the PFileProviderCustomAction protocol.

func (FileProviderCustomActionObject) HasPerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler

func (f_ FileProviderCustomActionObject) HasPerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler() bool

func (FileProviderCustomActionObject) PerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler

func (f_ FileProviderCustomActionObject) PerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler(actionIdentifier FileProviderExtensionActionIdentifier, itemIdentifiers []FileProviderItemIdentifier, completionHandler func(error foundation.Error)) foundation.Progress

Tells the File Provider extension to perform a custom action. Full Topic

type FileProviderDeleteItemOptions

type FileProviderDeleteItemOptions uint

Options for deleting items. Full Topic

const (
	FileProviderDeleteItemRecursive FileProviderDeleteItemOptions = 1
)

type FileProviderDomain

type FileProviderDomain struct {
	objc.Object
}

A File Provider extension's domain. Full Topic

func FileProviderDomainFrom

func FileProviderDomainFrom(ptr unsafe.Pointer) FileProviderDomain

func NewFileProviderDomain

func NewFileProviderDomain() FileProviderDomain

func NewFileProviderDomainWithIdentifierDisplayName

func NewFileProviderDomainWithIdentifierDisplayName(identifier FileProviderDomainIdentifier, displayName string) FileProviderDomain

Creates a new file provider domain with the specified identifier and display name. Full Topic

func (FileProviderDomain) BackingStoreIdentity

func (f_ FileProviderDomain) BackingStoreIdentity() []byte

A unique identifier for the backing store used by the system. Full Topic

func (FileProviderDomain) DisplayName

func (f_ FileProviderDomain) DisplayName() string

The name of the domain displayed in the user interface. Full Topic

func (FileProviderDomain) Identifier

The domain's unique identifier. Full Topic

func (FileProviderDomain) Init

func (FileProviderDomain) InitWithIdentifierDisplayName

func (f_ FileProviderDomain) InitWithIdentifierDisplayName(identifier FileProviderDomainIdentifier, displayName string) FileProviderDomain

func (FileProviderDomain) IsDisconnected

func (f_ FileProviderDomain) IsDisconnected() bool

A Boolean value indicating that the domain is present, but disconnected from the file extension. Full Topic

func (FileProviderDomain) IsHidden

func (f_ FileProviderDomain) IsHidden() bool

A Boolean value that determines whether the domain is visible to users. Full Topic

func (FileProviderDomain) SetHidden

func (f_ FileProviderDomain) SetHidden(value bool)

A Boolean value that determines whether the domain is visible to users. Full Topic

func (FileProviderDomain) SetTestingModes

func (f_ FileProviderDomain) SetTestingModes(value FileProviderDomainTestingModes)

A mode that gives the File Provider extension more control over the system’s behavior during testing. Full Topic

func (FileProviderDomain) TestingModes

A mode that gives the File Provider extension more control over the system’s behavior during testing. Full Topic

func (FileProviderDomain) UserEnabled

func (f_ FileProviderDomain) UserEnabled() bool

A Boolean value that indicates whether the user has enabled or disabled the domain. Full Topic

type FileProviderDomainIdentifier

type FileProviderDomainIdentifier string

A unique identifier for a file provider's domain. Full Topic

type FileProviderDomainRemovalMode

type FileProviderDomainRemovalMode int

A mode indicating how the system handles user data when removing a domain. Full Topic

const (
	FileProviderDomainRemovalModePreserveDirtyUserData      FileProviderDomainRemovalMode = 1
	FileProviderDomainRemovalModePreserveDownloadedUserData FileProviderDomainRemovalMode = 2
	FileProviderDomainRemovalModeRemoveAll                  FileProviderDomainRemovalMode = 0
)

type FileProviderDomainStateObject

type FileProviderDomainStateObject struct {
	objc.Object
}

A concrete type for the PFileProviderDomainState protocol.

func (FileProviderDomainStateObject) DomainVersion

An opaque object that uniquely identifies the domain’s version. Full Topic

func (FileProviderDomainStateObject) HasDomainVersion

func (f_ FileProviderDomainStateObject) HasDomainVersion() bool

func (FileProviderDomainStateObject) HasUserInfo

func (f_ FileProviderDomainStateObject) HasUserInfo() bool

func (FileProviderDomainStateObject) UserInfo

Global state information about the current domain version. Full Topic

type FileProviderDomainTestingModes

type FileProviderDomainTestingModes uint

Modes that modify the system’s behavior while testing. Full Topic

const (
	FileProviderDomainTestingModeAlwaysEnabled FileProviderDomainTestingModes = 1
	FileProviderDomainTestingModeInteractive   FileProviderDomainTestingModes = 2
)

type FileProviderDomainVersion

type FileProviderDomainVersion struct {
	objc.Object
}

An opaque object that identifies a specific version of a domain. Full Topic

func FileProviderDomainVersionFrom

func FileProviderDomainVersionFrom(ptr unsafe.Pointer) FileProviderDomainVersion

func NewFileProviderDomainVersion

func NewFileProviderDomainVersion() FileProviderDomainVersion

func (FileProviderDomainVersion) Compare

Compares another domain version with this one. Full Topic

func (FileProviderDomainVersion) Init

func (FileProviderDomainVersion) Next

Creates a new version that supersedes the current version. Full Topic

type FileProviderEnumeratingObject

type FileProviderEnumeratingObject struct {
	objc.Object
}

A concrete type for the PFileProviderEnumerating protocol.

func (FileProviderEnumeratingObject) EnumeratorForContainerItemIdentifierRequestError

func (f_ FileProviderEnumeratingObject) EnumeratorForContainerItemIdentifierRequestError(containerItemIdentifier FileProviderItemIdentifier, request FileProviderRequest, error unsafe.Pointer) FileProviderEnumeratorObject

Tells the file provider to return an enumerator for the provided directory. Full Topic

func (FileProviderEnumeratingObject) HasEnumeratorForContainerItemIdentifierRequestError

func (f_ FileProviderEnumeratingObject) HasEnumeratorForContainerItemIdentifierRequestError() bool

type FileProviderEnumerationObserverObject

type FileProviderEnumerationObserverObject struct {
	objc.Object
}

A concrete type for the PFileProviderEnumerationObserver protocol.

func (FileProviderEnumerationObserverObject) DidEnumerateItems

func (f_ FileProviderEnumerationObserverObject) DidEnumerateItems(updatedItems []objc.Object)

Provides a batch of enumerated items. Full Topic

func (FileProviderEnumerationObserverObject) FinishEnumeratingUpToPage

func (f_ FileProviderEnumerationObserverObject) FinishEnumeratingUpToPage(nextPage FileProviderPage)

Tells the observer that all of the items have been enumerated up to the specified page. Full Topic

func (FileProviderEnumerationObserverObject) FinishEnumeratingWithError

func (f_ FileProviderEnumerationObserverObject) FinishEnumeratingWithError(error foundation.Error)

Tells the observer that an error occurred during item enumeration. Full Topic

func (FileProviderEnumerationObserverObject) HasDidEnumerateItems

func (f_ FileProviderEnumerationObserverObject) HasDidEnumerateItems() bool

func (FileProviderEnumerationObserverObject) HasFinishEnumeratingUpToPage

func (f_ FileProviderEnumerationObserverObject) HasFinishEnumeratingUpToPage() bool

func (FileProviderEnumerationObserverObject) HasFinishEnumeratingWithError

func (f_ FileProviderEnumerationObserverObject) HasFinishEnumeratingWithError() bool

func (FileProviderEnumerationObserverObject) HasSuggestedPageSize

func (f_ FileProviderEnumerationObserverObject) HasSuggestedPageSize() bool

func (FileProviderEnumerationObserverObject) SuggestedPageSize

func (f_ FileProviderEnumerationObserverObject) SuggestedPageSize() int

The page size that the system recommends. Full Topic

type FileProviderEnumeratorObject

type FileProviderEnumeratorObject struct {
	objc.Object
}

A concrete type for the PFileProviderEnumerator protocol.

func (FileProviderEnumeratorObject) CurrentSyncAnchorWithCompletionHandler

func (f_ FileProviderEnumeratorObject) CurrentSyncAnchorWithCompletionHandler(completionHandler func(currentAnchor FileProviderSyncAnchor))

Returns the current sync anchor. Full Topic

func (FileProviderEnumeratorObject) EnumerateChangesForObserverFromSyncAnchor

func (f_ FileProviderEnumeratorObject) EnumerateChangesForObserverFromSyncAnchor(observer FileProviderChangeObserverObject, syncAnchor FileProviderSyncAnchor)

Requests the next batch of changes after the specified sync anchor. Full Topic

func (FileProviderEnumeratorObject) EnumerateItemsForObserverStartingAtPage

func (f_ FileProviderEnumeratorObject) EnumerateItemsForObserverStartingAtPage(observer FileProviderEnumerationObserverObject, page FileProviderPage)

Requests the next batch of items, starting at the specified page. Full Topic

func (FileProviderEnumeratorObject) HasCurrentSyncAnchorWithCompletionHandler

func (f_ FileProviderEnumeratorObject) HasCurrentSyncAnchorWithCompletionHandler() bool

func (FileProviderEnumeratorObject) HasEnumerateChangesForObserverFromSyncAnchor

func (f_ FileProviderEnumeratorObject) HasEnumerateChangesForObserverFromSyncAnchor() bool

func (FileProviderEnumeratorObject) HasEnumerateItemsForObserverStartingAtPage

func (f_ FileProviderEnumeratorObject) HasEnumerateItemsForObserverStartingAtPage() bool

func (FileProviderEnumeratorObject) HasInvalidate

func (f_ FileProviderEnumeratorObject) HasInvalidate() bool

func (FileProviderEnumeratorObject) Invalidate

func (f_ FileProviderEnumeratorObject) Invalidate()

Stops the enumeration of items and changes. Full Topic

type FileProviderErrorCode

type FileProviderErrorCode int

The error codes for the File Provider extension. Full Topic

const (
	FileProviderErrorCannotSynchronize            FileProviderErrorCode = -2005
	FileProviderErrorDeletionRejected             FileProviderErrorCode = -1006
	FileProviderErrorDirectoryNotEmpty            FileProviderErrorCode = -1007
	FileProviderErrorFilenameCollision            FileProviderErrorCode = -1001
	FileProviderErrorInsufficientQuota            FileProviderErrorCode = -1003
	FileProviderErrorNewerExtensionVersionFound   FileProviderErrorCode = -2004
	FileProviderErrorNoSuchItem                   FileProviderErrorCode = -1005
	FileProviderErrorNonEvictable                 FileProviderErrorCode = -2008
	FileProviderErrorNonEvictableChildren         FileProviderErrorCode = -2006
	FileProviderErrorNotAuthenticated             FileProviderErrorCode = -1000
	FileProviderErrorOlderExtensionVersionRunning FileProviderErrorCode = -2003
	FileProviderErrorPageExpired                  FileProviderErrorCode = -1002
	FileProviderErrorProviderNotFound             FileProviderErrorCode = -2001
	FileProviderErrorProviderTranslocated         FileProviderErrorCode = -2002
	FileProviderErrorServerUnreachable            FileProviderErrorCode = -1004
	FileProviderErrorSyncAnchorExpired            FileProviderErrorCode = -1002
	FileProviderErrorUnsyncedEdits                FileProviderErrorCode = -2007
	FileProviderErrorVersionNoLongerAvailable     FileProviderErrorCode = -2009
)

type FileProviderExtensionActionIdentifier

type FileProviderExtensionActionIdentifier string

An identifier for custom actions. Full Topic

type FileProviderFetchContentsOptions

type FileProviderFetchContentsOptions uint

Options for fetching a range of data from a file. Full Topic

const (
	FileProviderFetchContentsOptionsStrictVersioning FileProviderFetchContentsOptions = 1
)

type FileProviderFileSystemFlags

type FileProviderFileSystemFlags uint

Flags that define an item’s on-disk properties and its appearance in the user interface. Full Topic

const (
	FileProviderFileSystemHidden              FileProviderFileSystemFlags = 8
	FileProviderFileSystemPathExtensionHidden FileProviderFileSystemFlags = 16
	FileProviderFileSystemUserExecutable      FileProviderFileSystemFlags = 1
	FileProviderFileSystemUserReadable        FileProviderFileSystemFlags = 2
	FileProviderFileSystemUserWritable        FileProviderFileSystemFlags = 4
)

type FileProviderIncrementalContentFetchingObject

type FileProviderIncrementalContentFetchingObject struct {
	objc.Object
}

A concrete type for the PFileProviderIncrementalContentFetching protocol.

func (FileProviderIncrementalContentFetchingObject) FetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler

func (f_ FileProviderIncrementalContentFetchingObject) FetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, existingContents foundation.URL, existingVersion FileProviderItemVersion, request FileProviderRequest, completionHandler func(fileContents foundation.URL, item objc.Object, error foundation.Error)) foundation.Progress

Asks the file provider for an update of the specified item. Full Topic

func (FileProviderIncrementalContentFetchingObject) HasFetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler

func (f_ FileProviderIncrementalContentFetchingObject) HasFetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler() bool

type FileProviderItemCapabilities

type FileProviderItemCapabilities uint

An item’s capabilities, which define the actions that the user can perform in the document browser. Full Topic

const (
	FileProviderItemCapabilitiesAllowsAddingSubItems     FileProviderItemCapabilities = 2
	FileProviderItemCapabilitiesAllowsAll                FileProviderItemCapabilities = 63
	FileProviderItemCapabilitiesAllowsContentEnumerating FileProviderItemCapabilities = 1
	FileProviderItemCapabilitiesAllowsDeleting           FileProviderItemCapabilities = 32
	FileProviderItemCapabilitiesAllowsEvicting           FileProviderItemCapabilities = 64
	FileProviderItemCapabilitiesAllowsExcludingFromSync  FileProviderItemCapabilities = 128
	FileProviderItemCapabilitiesAllowsReading            FileProviderItemCapabilities = 1
	FileProviderItemCapabilitiesAllowsRenaming           FileProviderItemCapabilities = 8
	FileProviderItemCapabilitiesAllowsReparenting        FileProviderItemCapabilities = 4
	FileProviderItemCapabilitiesAllowsTrashing           FileProviderItemCapabilities = 16
	FileProviderItemCapabilitiesAllowsWriting            FileProviderItemCapabilities = 2
)

type FileProviderItemDecoratingObject

type FileProviderItemDecoratingObject struct {
	objc.Object
}

A concrete type for the PFileProviderItemDecorating protocol.

func (FileProviderItemDecoratingObject) Decorations

Asks the item for an array of decorations. Full Topic

func (FileProviderItemDecoratingObject) HasDecorations

func (f_ FileProviderItemDecoratingObject) HasDecorations() bool

type FileProviderItemDecorationIdentifier

type FileProviderItemDecorationIdentifier string

A decoration identifier defined in the File Provider extension’s information property list. Full Topic

type FileProviderItemFields

type FileProviderItemFields uint

Fields that specify which of the item’s properties have changed. Full Topic

const (
	FileProviderItemContentModificationDate FileProviderItemFields = 128
	FileProviderItemContents                FileProviderItemFields = 1
	FileProviderItemCreationDate            FileProviderItemFields = 64
	FileProviderItemExtendedAttributes      FileProviderItemFields = 512
	FileProviderItemFavoriteRank            FileProviderItemFields = 32
	FileProviderItemFileSystemFlags         FileProviderItemFields = 256
	FileProviderItemFilename                FileProviderItemFields = 2
	FileProviderItemLastUsedDate            FileProviderItemFields = 8
	FileProviderItemParentItemIdentifier    FileProviderItemFields = 4
	FileProviderItemTagData                 FileProviderItemFields = 16
	FileProviderItemTypeAndCreator          FileProviderItemFields = 1024
)

type FileProviderItemIdentifier

type FileProviderItemIdentifier string

A unique identifier for an item managed by the File Provider extension. Full Topic

const (
	FileProviderRootContainerItemIdentifier       FileProviderItemIdentifier = "NSFileProviderRootContainerItemIdentifier"
	FileProviderTrashContainerItemIdentifier      FileProviderItemIdentifier = "NSFileProviderTrashContainerItemIdentifier"
	FileProviderWorkingSetContainerItemIdentifier FileProviderItemIdentifier = "NSFileProviderWorkingSetContainerItemIdentifier"
)

type FileProviderItemVersion

type FileProviderItemVersion struct {
	objc.Object
}

The version of the item’s content and its metadata. Full Topic

func FileProviderItemVersionFrom

func FileProviderItemVersionFrom(ptr unsafe.Pointer) FileProviderItemVersion

func NewFileProviderItemVersion

func NewFileProviderItemVersion() FileProviderItemVersion

func NewFileProviderItemVersionWithContentVersionMetadataVersion

func NewFileProviderItemVersionWithContentVersionMetadataVersion(contentVersion []byte, metadataVersion []byte) FileProviderItemVersion

Creates a new version object. Full Topic

func (FileProviderItemVersion) ContentVersion

func (f_ FileProviderItemVersion) ContentVersion() []byte

An opaque object used to track versions of the item’s content. Full Topic

func (FileProviderItemVersion) Init

func (FileProviderItemVersion) InitWithContentVersionMetadataVersion

func (f_ FileProviderItemVersion) InitWithContentVersionMetadataVersion(contentVersion []byte, metadataVersion []byte) FileProviderItemVersion

func (FileProviderItemVersion) MetadataVersion

func (f_ FileProviderItemVersion) MetadataVersion() []byte

An opaque object used to track versions of the item’s metadata. Full Topic

type FileProviderManager

type FileProviderManager struct {
	objc.Object
}

A manager object that you use to communicate with the file provider from either your app or your File Provider extension. Full Topic

func FileProviderManagerFrom

func FileProviderManagerFrom(ptr unsafe.Pointer) FileProviderManager

func FileProviderManager_ManagerForDomain

func FileProviderManager_ManagerForDomain(domain IFileProviderDomain) FileProviderManager

Returns a newly created file provider manager for the specified domain. Full Topic

func NewFileProviderManager

func NewFileProviderManager() FileProviderManager

func (FileProviderManager) DisconnectWithReasonOptionsCompletionHandler

func (f_ FileProviderManager) DisconnectWithReasonOptionsCompletionHandler(localizedReason string, options FileProviderManagerDisconnectionOptions, completionHandler func(error foundation.Error))

Disconnects the domain from the extension. Full Topic

func (FileProviderManager) EnumeratorForMaterializedItems

func (f_ FileProviderManager) EnumeratorForMaterializedItems() FileProviderEnumeratorObject

Returns an enumerator for all the items the system currently stores on disk. Full Topic

func (FileProviderManager) EnumeratorForPendingItems

func (f_ FileProviderManager) EnumeratorForPendingItems() FileProviderPendingSetEnumeratorObject

Returns an enumerator for the set of pending items. Full Topic

func (FileProviderManager) EvictItemWithIdentifierCompletionHandler

func (f_ FileProviderManager) EvictItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))

Asks the system to remove an item from its cache. Full Topic

func (FileProviderManager) GetUserVisibleURLForItemIdentifierCompletionHandler

func (f_ FileProviderManager) GetUserVisibleURLForItemIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(userVisibleFile foundation.URL, error foundation.Error))

Returns the user-visible URL for an item. Full Topic

func (FileProviderManager) GlobalProgressForKind

Returns a progress object that tracks either the uploading or downloading of items from the File Provider extension’s remote storage. Full Topic

func (FileProviderManager) Init

func (FileProviderManager) ListAvailableTestingOperationsWithError

func (f_ FileProviderManager) ListAvailableTestingOperationsWithError(error unsafe.Pointer) []FileProviderTestingOperationObject

Lists all the operations that are ready for scheduling. Full Topic

func (FileProviderManager) ReconnectWithCompletionHandler

func (f_ FileProviderManager) ReconnectWithCompletionHandler(completionHandler func(error foundation.Error))

Reconnects the domain with the extension. Full Topic

func (FileProviderManager) RegisterURLSessionTaskForItemWithIdentifierCompletionHandler

func (f_ FileProviderManager) RegisterURLSessionTaskForItemWithIdentifierCompletionHandler(task foundation.IURLSessionTask, identifier FileProviderItemIdentifier, completion func(error foundation.Error))

Registers the URL session task responsible for the specified item. Full Topic

func (FileProviderManager) ReimportItemsBelowItemWithIdentifierCompletionHandler

func (f_ FileProviderManager) ReimportItemsBelowItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))

Tells the system to reimport the item and its content recursively. Full Topic

func (FileProviderManager) RunTestingOperationsError

func (f_ FileProviderManager) RunTestingOperationsError(operations []PFileProviderTestingOperation, error unsafe.Pointer) foundation.Dictionary

Asks the system to schedule and execute the specified operations. Full Topic

func (FileProviderManager) SignalEnumeratorForContainerItemIdentifierCompletionHandler

func (f_ FileProviderManager) SignalEnumeratorForContainerItemIdentifierCompletionHandler(containerItemIdentifier FileProviderItemIdentifier, completion func(error foundation.Error))

Alerts the system to changes in the specified folder’s content. Full Topic

func (FileProviderManager) SignalErrorResolvedCompletionHandler

func (f_ FileProviderManager) SignalErrorResolvedCompletionHandler(error foundation.IError, completionHandler func(error foundation.Error))

Indicates a resolved error. Full Topic

func (FileProviderManager) TemporaryDirectoryURLWithError

func (f_ FileProviderManager) TemporaryDirectoryURLWithError(error unsafe.Pointer) foundation.URL

Returns the URL of a directory that the File Provider extension can use to temporarily store files before passing them to the system. Full Topic

func (FileProviderManager) WaitForChangesOnItemsBelowItemWithIdentifierCompletionHandler

func (f_ FileProviderManager) WaitForChangesOnItemsBelowItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))

Requests a notification after the system completes all the specified changes. Full Topic

func (FileProviderManager) WaitForStabilizationWithCompletionHandler

func (f_ FileProviderManager) WaitForStabilizationWithCompletionHandler(completionHandler func(error foundation.Error))

Requests a notification after the domain stabilizes. Full Topic

type FileProviderManagerDisconnectionOptions

type FileProviderManagerDisconnectionOptions uint

Options for disconnecting a domain from the extension. Full Topic

const (
	FileProviderManagerDisconnectionOptionsTemporary FileProviderManagerDisconnectionOptions = 1
)

type FileProviderMaterializationFlags

type FileProviderMaterializationFlags uint

Flags that provides additional information about the provided content. Full Topic

const (
	FileProviderMaterializationFlagsKnownSparseRanges FileProviderMaterializationFlags = 1
)

type FileProviderModifyItemOptions

type FileProviderModifyItemOptions uint

Options for modifying items. Full Topic

const (
	FileProviderModifyItemMayAlreadyExist FileProviderModifyItemOptions = 1
)

type FileProviderPage

type FileProviderPage = foundation.Data

type FileProviderPartialContentFetchingObject

type FileProviderPartialContentFetchingObject struct {
	objc.Object
}

A concrete type for the PFileProviderPartialContentFetching protocol.

func (FileProviderPartialContentFetchingObject) FetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler

func (f_ FileProviderPartialContentFetchingObject) FetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, request FileProviderRequest, requestedRange foundation.Range, alignment uint, options FileProviderFetchContentsOptions, completionHandler func(fileContents foundation.URL, item objc.Object, retrievedRange foundation.Range, flags FileProviderMaterializationFlags, error foundation.Error)) foundation.Progress

Tells the file provider to download the requested item from remote storage. Full Topic

func (FileProviderPartialContentFetchingObject) HasFetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler

func (f_ FileProviderPartialContentFetchingObject) HasFetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler() bool

type FileProviderPendingSetEnumeratorObject

type FileProviderPendingSetEnumeratorObject struct {
	objc.Object
}

A concrete type for the PFileProviderPendingSetEnumerator protocol.

func (FileProviderPendingSetEnumeratorObject) DomainVersion

The domain version when the system last refreshed the pending set. Full Topic

func (FileProviderPendingSetEnumeratorObject) HasDomainVersion

func (f_ FileProviderPendingSetEnumeratorObject) HasDomainVersion() bool

func (FileProviderPendingSetEnumeratorObject) HasRefreshInterval

func (f_ FileProviderPendingSetEnumeratorObject) HasRefreshInterval() bool

func (FileProviderPendingSetEnumeratorObject) RefreshInterval

The amount of time, in seconds, between updates to the pending set. Full Topic

type FileProviderReplicatedExtensionObject

type FileProviderReplicatedExtensionObject struct {
	objc.Object
}

A concrete type for the PFileProviderReplicatedExtension protocol.

func (FileProviderReplicatedExtensionObject) CreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) CreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler(itemTemplate objc.Object, fields FileProviderItemFields, url foundation.URL, options FileProviderCreateItemOptions, request FileProviderRequest, completionHandler func(createdItem objc.Object, stillPendingFields FileProviderItemFields, shouldFetchContent bool, error foundation.Error)) foundation.Progress

Tells the file provider to create or import an item based on a template. Full Topic

func (FileProviderReplicatedExtensionObject) DeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) DeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler(identifier FileProviderItemIdentifier, version FileProviderItemVersion, options FileProviderDeleteItemOptions, request FileProviderRequest, completionHandler func(arg0 foundation.Error)) foundation.Progress

Tells the file provider to delete an item forever. Full Topic

func (FileProviderReplicatedExtensionObject) FetchContentsForItemWithIdentifierVersionRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) FetchContentsForItemWithIdentifierVersionRequestCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, request FileProviderRequest, completionHandler func(fileContents foundation.URL, item objc.Object, error foundation.Error)) foundation.Progress

Tells the file provider to download the requested item from remote storage. Full Topic

func (FileProviderReplicatedExtensionObject) HasCreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasCreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasDeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasDeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasFetchContentsForItemWithIdentifierVersionRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasFetchContentsForItemWithIdentifierVersionRequestCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasImportDidFinishWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasImportDidFinishWithCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasInitWithDomain

func (f_ FileProviderReplicatedExtensionObject) HasInitWithDomain() bool

func (FileProviderReplicatedExtensionObject) HasInvalidate

func (f_ FileProviderReplicatedExtensionObject) HasInvalidate() bool

func (FileProviderReplicatedExtensionObject) HasItemForIdentifierRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasItemForIdentifierRequestCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasMaterializedItemsDidChangeWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasMaterializedItemsDidChangeWithCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) HasPendingItemsDidChangeWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) HasPendingItemsDidChangeWithCompletionHandler() bool

func (FileProviderReplicatedExtensionObject) ImportDidFinishWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) ImportDidFinishWithCompletionHandler(completionHandler func())

Tells the File Provider extension that the system finished importing items. Full Topic

func (FileProviderReplicatedExtensionObject) InitWithDomain

Creates an instance of the file provider for the specified domain. Full Topic

func (FileProviderReplicatedExtensionObject) Invalidate

func (f_ FileProviderReplicatedExtensionObject) Invalidate()

Tells the file provider to perform any necessary cleanup so that the system can deallocate it. Full Topic

func (FileProviderReplicatedExtensionObject) ItemForIdentifierRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) ItemForIdentifierRequestCompletionHandler(identifier FileProviderItemIdentifier, request FileProviderRequest, completionHandler func(arg0 objc.Object, arg1 foundation.Error)) foundation.Progress

Asks the file provider for the metadata of the provided item. Full Topic

func (FileProviderReplicatedExtensionObject) MaterializedItemsDidChangeWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) MaterializedItemsDidChangeWithCompletionHandler(completionHandler func())

Tells the file provider that the set of materialized items changed. Full Topic

func (FileProviderReplicatedExtensionObject) ModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) ModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler(item objc.Object, version FileProviderItemVersion, changedFields FileProviderItemFields, newContents foundation.URL, options FileProviderModifyItemOptions, request FileProviderRequest, completionHandler func(item objc.Object, stillPendingFields FileProviderItemFields, shouldFetchContent bool, error foundation.Error)) foundation.Progress

Tells the file provider that an item’s content or metadata changed. Full Topic

func (FileProviderReplicatedExtensionObject) PendingItemsDidChangeWithCompletionHandler

func (f_ FileProviderReplicatedExtensionObject) PendingItemsDidChangeWithCompletionHandler(completionHandler func())

Tells the file provider extension that the set of pending items has changed. Full Topic

type FileProviderRequest

type FileProviderRequest struct {
	objc.Object
}

An object that provides information about the application requesting data from the File Provider extension. Full Topic

func FileProviderRequestFrom

func FileProviderRequestFrom(ptr unsafe.Pointer) FileProviderRequest

func NewFileProviderRequest

func NewFileProviderRequest() FileProviderRequest

func (FileProviderRequest) DomainVersion

The version of the domain for the request. Full Topic

func (FileProviderRequest) Init

func (FileProviderRequest) IsFileViewerRequest

func (f_ FileProviderRequest) IsFileViewerRequest() bool

A Boolean value that indicates whether the request came from Finder or related system file browsers. Full Topic

func (FileProviderRequest) IsSystemRequest

func (f_ FileProviderRequest) IsSystemRequest() bool

A Boolean value that indicates whether the request came from a system process. Full Topic

func (FileProviderRequest) RequestingExecutable

func (f_ FileProviderRequest) RequestingExecutable() foundation.URL

The URL of the requesting executable. Full Topic

type FileProviderServiceSourceObject

type FileProviderServiceSourceObject struct {
	objc.Object
}

A concrete type for the PFileProviderServiceSource protocol.

func (FileProviderServiceSourceObject) HasMakeListenerEndpointAndReturnError

func (f_ FileProviderServiceSourceObject) HasMakeListenerEndpointAndReturnError() bool

func (FileProviderServiceSourceObject) HasServiceName

func (f_ FileProviderServiceSourceObject) HasServiceName() bool

func (FileProviderServiceSourceObject) MakeListenerEndpointAndReturnError

func (f_ FileProviderServiceSourceObject) MakeListenerEndpointAndReturnError(error unsafe.Pointer) foundation.XPCListenerEndpoint

Returns an endpoint object that lets the host app communicate with the File Provider extension. Full Topic

func (FileProviderServiceSourceObject) ServiceName

A name that uniquely identifies the service (reverse domain name notation is recommended). Full Topic

type FileProviderServicingObject

type FileProviderServicingObject struct {
	objc.Object
}

A concrete type for the PFileProviderServicing protocol.

func (FileProviderServicingObject) HasSupportedServiceSourcesForItemIdentifierCompletionHandler

func (f_ FileProviderServicingObject) HasSupportedServiceSourcesForItemIdentifierCompletionHandler() bool

func (FileProviderServicingObject) SupportedServiceSourcesForItemIdentifierCompletionHandler

func (f_ FileProviderServicingObject) SupportedServiceSourcesForItemIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(arg0 []FileProviderServiceSourceObject, arg1 foundation.Error)) foundation.Progress

Asks the File Provider extension for an array of custom communication channels. Full Topic

type FileProviderSyncAnchor

type FileProviderSyncAnchor = foundation.Data

type FileProviderTestingChildrenEnumerationObject

type FileProviderTestingChildrenEnumerationObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingChildrenEnumeration protocol.

func (FileProviderTestingChildrenEnumerationObject) HasItemIdentifier

func (f_ FileProviderTestingChildrenEnumerationObject) HasItemIdentifier() bool

func (FileProviderTestingChildrenEnumerationObject) HasSide

func (FileProviderTestingChildrenEnumerationObject) ItemIdentifier

The containing identifier’s unique identifier. Full Topic

func (FileProviderTestingChildrenEnumerationObject) Side

The item’s location. Full Topic

type FileProviderTestingCollisionResolutionObject

type FileProviderTestingCollisionResolutionObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingCollisionResolution protocol.

func (FileProviderTestingCollisionResolutionObject) HasRenamedItem

func (FileProviderTestingCollisionResolutionObject) HasSide

func (FileProviderTestingCollisionResolutionObject) RenamedItem

A description of the renamed item. Full Topic

func (FileProviderTestingCollisionResolutionObject) Side

The item’s location. Full Topic

type FileProviderTestingContentFetchObject

type FileProviderTestingContentFetchObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingContentFetch protocol.

func (FileProviderTestingContentFetchObject) HasItemIdentifier

func (f_ FileProviderTestingContentFetchObject) HasItemIdentifier() bool

func (FileProviderTestingContentFetchObject) HasSide

func (FileProviderTestingContentFetchObject) ItemIdentifier

The containing item’s unique identifier. Full Topic

func (FileProviderTestingContentFetchObject) Side

The item’s location. Full Topic

type FileProviderTestingCreationObject

type FileProviderTestingCreationObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingCreation protocol.

func (FileProviderTestingCreationObject) DomainVersion

The domain’s version when the system discovered the item at the source location. Full Topic

func (FileProviderTestingCreationObject) HasDomainVersion

func (f_ FileProviderTestingCreationObject) HasDomainVersion() bool

func (FileProviderTestingCreationObject) HasSourceItem

func (f_ FileProviderTestingCreationObject) HasSourceItem() bool

func (FileProviderTestingCreationObject) HasTargetSide

func (f_ FileProviderTestingCreationObject) HasTargetSide() bool

func (FileProviderTestingCreationObject) SourceItem

A description of the item stored at the source. Full Topic

func (FileProviderTestingCreationObject) TargetSide

The target location for the new item. Full Topic

type FileProviderTestingDeletionObject

type FileProviderTestingDeletionObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingDeletion protocol.

func (FileProviderTestingDeletionObject) DomainVersion

The domain’s version when the source location deleted the item. Full Topic

func (FileProviderTestingDeletionObject) HasDomainVersion

func (f_ FileProviderTestingDeletionObject) HasDomainVersion() bool

func (FileProviderTestingDeletionObject) HasSourceItemIdentifier

func (f_ FileProviderTestingDeletionObject) HasSourceItemIdentifier() bool

func (FileProviderTestingDeletionObject) HasTargetItemBaseVersion

func (f_ FileProviderTestingDeletionObject) HasTargetItemBaseVersion() bool

func (FileProviderTestingDeletionObject) HasTargetItemIdentifier

func (f_ FileProviderTestingDeletionObject) HasTargetItemIdentifier() bool

func (FileProviderTestingDeletionObject) HasTargetSide

func (f_ FileProviderTestingDeletionObject) HasTargetSide() bool

func (FileProviderTestingDeletionObject) SourceItemIdentifier

The unique identifier for the source item. Full Topic

func (FileProviderTestingDeletionObject) TargetItemBaseVersion

The version of the deleted item. Full Topic

func (FileProviderTestingDeletionObject) TargetItemIdentifier

The unique identifier for the target item. Full Topic

func (FileProviderTestingDeletionObject) TargetSide

The target location for the delete operation. Full Topic

type FileProviderTestingIngestionObject

type FileProviderTestingIngestionObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingIngestion protocol.

func (FileProviderTestingIngestionObject) HasItem

func (FileProviderTestingIngestionObject) HasItemIdentifier

func (f_ FileProviderTestingIngestionObject) HasItemIdentifier() bool

func (FileProviderTestingIngestionObject) HasSide

func (FileProviderTestingIngestionObject) Item

A description of the item that changed. Full Topic

func (FileProviderTestingIngestionObject) ItemIdentifier

The unique identifier for the item that changed. Full Topic

func (FileProviderTestingIngestionObject) Side

The location where the change occurred. Full Topic

type FileProviderTestingLookupObject

type FileProviderTestingLookupObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingLookup protocol.

func (FileProviderTestingLookupObject) HasItemIdentifier

func (f_ FileProviderTestingLookupObject) HasItemIdentifier() bool

func (FileProviderTestingLookupObject) HasSide

func (FileProviderTestingLookupObject) ItemIdentifier

The unique identifier for the item. Full Topic

func (FileProviderTestingLookupObject) Side

The location where the lookup occurs. Full Topic

type FileProviderTestingModificationObject

type FileProviderTestingModificationObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingModification protocol.

func (FileProviderTestingModificationObject) ChangedFields

A list of the fields that changed. Full Topic

func (FileProviderTestingModificationObject) DomainVersion

The domain’s version when the change occurred. Full Topic

func (FileProviderTestingModificationObject) HasChangedFields

func (f_ FileProviderTestingModificationObject) HasChangedFields() bool

func (FileProviderTestingModificationObject) HasDomainVersion

func (f_ FileProviderTestingModificationObject) HasDomainVersion() bool

func (FileProviderTestingModificationObject) HasSourceItem

func (f_ FileProviderTestingModificationObject) HasSourceItem() bool

func (FileProviderTestingModificationObject) HasTargetItemBaseVersion

func (f_ FileProviderTestingModificationObject) HasTargetItemBaseVersion() bool

func (FileProviderTestingModificationObject) HasTargetItemIdentifier

func (f_ FileProviderTestingModificationObject) HasTargetItemIdentifier() bool

func (FileProviderTestingModificationObject) HasTargetSide

func (f_ FileProviderTestingModificationObject) HasTargetSide() bool

func (FileProviderTestingModificationObject) SourceItem

A description of the source item. Full Topic

func (FileProviderTestingModificationObject) TargetItemBaseVersion

The version of the changed item. Full Topic

func (FileProviderTestingModificationObject) TargetItemIdentifier

The unique identifier for the target item. Full Topic

func (FileProviderTestingModificationObject) TargetSide

The target location for the modification operation. Full Topic

type FileProviderTestingOperationObject

type FileProviderTestingOperationObject struct {
	objc.Object
}

A concrete type for the PFileProviderTestingOperation protocol.

func (FileProviderTestingOperationObject) AsChildrenEnumeration

Returns the operation if it enumerates contained items. Full Topic

func (FileProviderTestingOperationObject) AsCollisionResolution

Returns the operation if it resolves a collision by renaming the new item. Full Topic

func (FileProviderTestingOperationObject) AsContentFetch

Returns the operation if it fetches an item’s content. Full Topic

func (FileProviderTestingOperationObject) AsCreation

Returns the operation if it propagates the creation of an item. Full Topic

func (FileProviderTestingOperationObject) AsDeletion

Returns the operation if it propagates the deletion of an item. Full Topic

func (FileProviderTestingOperationObject) AsIngestion

Returns the operation if it alerts the system to changes. Full Topic

func (FileProviderTestingOperationObject) AsLookup

Returns the operation if it looks up an item. Full Topic

func (FileProviderTestingOperationObject) AsModification

Returns the operation if it propagates a change. Full Topic

func (FileProviderTestingOperationObject) HasAsChildrenEnumeration

func (f_ FileProviderTestingOperationObject) HasAsChildrenEnumeration() bool

func (FileProviderTestingOperationObject) HasAsCollisionResolution

func (f_ FileProviderTestingOperationObject) HasAsCollisionResolution() bool

func (FileProviderTestingOperationObject) HasAsContentFetch

func (f_ FileProviderTestingOperationObject) HasAsContentFetch() bool

func (FileProviderTestingOperationObject) HasAsCreation

func (f_ FileProviderTestingOperationObject) HasAsCreation() bool

func (FileProviderTestingOperationObject) HasAsDeletion

func (f_ FileProviderTestingOperationObject) HasAsDeletion() bool

func (FileProviderTestingOperationObject) HasAsIngestion

func (f_ FileProviderTestingOperationObject) HasAsIngestion() bool

func (FileProviderTestingOperationObject) HasAsLookup

func (f_ FileProviderTestingOperationObject) HasAsLookup() bool

func (FileProviderTestingOperationObject) HasAsModification

func (f_ FileProviderTestingOperationObject) HasAsModification() bool

func (FileProviderTestingOperationObject) HasType

func (FileProviderTestingOperationObject) Type

The operation’s type. Full Topic

type FileProviderTestingOperationSide

type FileProviderTestingOperationSide uint

The location where the operation takes place. Full Topic

const (
	FileProviderTestingOperationSideDisk         FileProviderTestingOperationSide = 0
	FileProviderTestingOperationSideFileProvider FileProviderTestingOperationSide = 1
)

type FileProviderTestingOperationType

type FileProviderTestingOperationType int

The action that an operation performs. Full Topic

const (
	FileProviderTestingOperationTypeChildrenEnumeration FileProviderTestingOperationType = 6
	FileProviderTestingOperationTypeCollisionResolution FileProviderTestingOperationType = 7
	FileProviderTestingOperationTypeContentFetch        FileProviderTestingOperationType = 5
	FileProviderTestingOperationTypeCreation            FileProviderTestingOperationType = 2
	FileProviderTestingOperationTypeDeletion            FileProviderTestingOperationType = 4
	FileProviderTestingOperationTypeIngestion           FileProviderTestingOperationType = 0
	FileProviderTestingOperationTypeLookup              FileProviderTestingOperationType = 1
	FileProviderTestingOperationTypeModification        FileProviderTestingOperationType = 3
)

type FileProviderThumbnailingObject

type FileProviderThumbnailingObject struct {
	objc.Object
}

A concrete type for the PFileProviderThumbnailing protocol.

func (FileProviderThumbnailingObject) FetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler

func (f_ FileProviderThumbnailingObject) FetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler(itemIdentifiers []FileProviderItemIdentifier, size coregraphics.Size, perThumbnailCompletionHandler func(identifier FileProviderItemIdentifier, imageData []byte, error foundation.Error), completionHandler func(error foundation.Error)) foundation.Progress

Asks the file provider for a thumbnail of the specified items. Full Topic

func (FileProviderThumbnailingObject) HasFetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler

func (f_ FileProviderThumbnailingObject) HasFetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler() bool

type FileProviderTypeAndCreator

type FileProviderTypeAndCreator struct {
	Type    uint32
	Creator uint32
}

A structure that contains the file type and file creator codes for an item. Full Topic

type FileProviderUserInteractionSuppressingObject

type FileProviderUserInteractionSuppressingObject struct {
	objc.Object
}

A concrete type for the PFileProviderUserInteractionSuppressing protocol.

func (FileProviderUserInteractionSuppressingObject) HasIsInteractionSuppressedForIdentifier

func (f_ FileProviderUserInteractionSuppressingObject) HasIsInteractionSuppressedForIdentifier() bool

func (FileProviderUserInteractionSuppressingObject) HasSetInteractionSuppressedForIdentifier

func (f_ FileProviderUserInteractionSuppressingObject) HasSetInteractionSuppressedForIdentifier() bool

func (FileProviderUserInteractionSuppressingObject) IsInteractionSuppressedForIdentifier

func (f_ FileProviderUserInteractionSuppressingObject) IsInteractionSuppressedForIdentifier(suppressionIdentifier string) bool

Asks the File Provider extension if the user suppressed the specified interaction. Full Topic

func (FileProviderUserInteractionSuppressingObject) SetInteractionSuppressedForIdentifier

func (f_ FileProviderUserInteractionSuppressingObject) SetInteractionSuppressedForIdentifier(suppression bool, suppressionIdentifier string)

Tells the File Provider extension that the user wants to suppress the user interaction. Full Topic

type IFileProviderDomain

type IFileProviderDomain interface {
	objc.IObject
	IsDisconnected() bool
	TestingModes() FileProviderDomainTestingModes
	SetTestingModes(value FileProviderDomainTestingModes)
	UserEnabled() bool
	Identifier() FileProviderDomainIdentifier
	DisplayName() string
	IsHidden() bool
	SetHidden(value bool)
	BackingStoreIdentity() []byte
}

An interface definition for the FileProviderDomain class.

type IFileProviderDomainVersion

type IFileProviderDomainVersion interface {
	objc.IObject
	Next() FileProviderDomainVersion
	Compare(otherVersion IFileProviderDomainVersion) foundation.ComparisonResult
}

An interface definition for the FileProviderDomainVersion class.

type IFileProviderItemVersion

type IFileProviderItemVersion interface {
	objc.IObject
	ContentVersion() []byte
	MetadataVersion() []byte
}

An interface definition for the FileProviderItemVersion class.

type IFileProviderManager

type IFileProviderManager interface {
	objc.IObject
	WaitForStabilizationWithCompletionHandler(completionHandler func(error foundation.Error))
	GlobalProgressForKind(kind foundation.ProgressFileOperationKind) foundation.Progress
	GetUserVisibleURLForItemIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(userVisibleFile foundation.URL, error foundation.Error))
	ListAvailableTestingOperationsWithError(error unsafe.Pointer) []FileProviderTestingOperationObject
	EnumeratorForMaterializedItems() FileProviderEnumeratorObject
	WaitForChangesOnItemsBelowItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))
	SignalEnumeratorForContainerItemIdentifierCompletionHandler(containerItemIdentifier FileProviderItemIdentifier, completion func(error foundation.Error))
	SignalErrorResolvedCompletionHandler(error foundation.IError, completionHandler func(error foundation.Error))
	RunTestingOperationsError(operations []PFileProviderTestingOperation, error unsafe.Pointer) foundation.Dictionary
	ReconnectWithCompletionHandler(completionHandler func(error foundation.Error))
	EvictItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))
	DisconnectWithReasonOptionsCompletionHandler(localizedReason string, options FileProviderManagerDisconnectionOptions, completionHandler func(error foundation.Error))
	TemporaryDirectoryURLWithError(error unsafe.Pointer) foundation.URL
	EnumeratorForPendingItems() FileProviderPendingSetEnumeratorObject
	ReimportItemsBelowItemWithIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(error foundation.Error))
	RegisterURLSessionTaskForItemWithIdentifierCompletionHandler(task foundation.IURLSessionTask, identifier FileProviderItemIdentifier, completion func(error foundation.Error))
}

An interface definition for the FileProviderManager class.

type IFileProviderRequest

type IFileProviderRequest interface {
	objc.IObject
	IsSystemRequest() bool
	DomainVersion() FileProviderDomainVersion
	RequestingExecutable() foundation.URL
	IsFileViewerRequest() bool
}

An interface definition for the FileProviderRequest class.

type PFileProviderChangeObserver

type PFileProviderChangeObserver interface {
	// optional
	DidDeleteItemsWithIdentifiers(deletedItemIdentifiers []FileProviderItemIdentifier)
	HasDidDeleteItemsWithIdentifiers() bool

	// optional
	FinishEnumeratingChangesUpToSyncAnchorMoreComing(anchor FileProviderSyncAnchor, moreComing bool)
	HasFinishEnumeratingChangesUpToSyncAnchorMoreComing() bool

	// optional
	DidUpdateItems(updatedItems []objc.Object)
	HasDidUpdateItems() bool

	// optional
	FinishEnumeratingWithError(error foundation.Error)
	HasFinishEnumeratingWithError() bool

	// optional
	SuggestedBatchSize() int
	HasSuggestedBatchSize() bool
}

An observer that receives changes and deletions during enumeration. Full Topic

type PFileProviderCustomAction

type PFileProviderCustomAction interface {
	// optional
	PerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler(actionIdentifier FileProviderExtensionActionIdentifier, itemIdentifiers []FileProviderItemIdentifier, completionHandler func(error foundation.Error)) foundation.Progress
	HasPerformActionWithIdentifierOnItemsWithIdentifiersCompletionHandler() bool
}

Support for custom actions. Full Topic

type PFileProviderDomainState

type PFileProviderDomainState interface {
	// optional
	UserInfo() foundation.Dictionary
	HasUserInfo() bool

	// optional
	DomainVersion() FileProviderDomainVersion
	HasDomainVersion() bool
}

An object that contains global state data about the domain. Full Topic

type PFileProviderEnumerating

type PFileProviderEnumerating interface {
	// optional
	EnumeratorForContainerItemIdentifierRequestError(containerItemIdentifier FileProviderItemIdentifier, request FileProviderRequest, error unsafe.Pointer) FileProviderEnumeratorObject
	HasEnumeratorForContainerItemIdentifierRequestError() bool
}

Support for enumerating the file provider’s contents. Full Topic

type PFileProviderEnumerationObserver

type PFileProviderEnumerationObserver interface {
	// optional
	DidEnumerateItems(updatedItems []objc.Object)
	HasDidEnumerateItems() bool

	// optional
	FinishEnumeratingUpToPage(nextPage FileProviderPage)
	HasFinishEnumeratingUpToPage() bool

	// optional
	FinishEnumeratingWithError(error foundation.Error)
	HasFinishEnumeratingWithError() bool

	// optional
	SuggestedPageSize() int
	HasSuggestedPageSize() bool
}

An observer that receives batches of items during enumeration. Full Topic

type PFileProviderEnumerator

type PFileProviderEnumerator interface {
	// optional
	EnumerateItemsForObserverStartingAtPage(observer FileProviderEnumerationObserverObject, page FileProviderPage)
	HasEnumerateItemsForObserverStartingAtPage() bool

	// optional
	EnumerateChangesForObserverFromSyncAnchor(observer FileProviderChangeObserverObject, syncAnchor FileProviderSyncAnchor)
	HasEnumerateChangesForObserverFromSyncAnchor() bool

	// optional
	CurrentSyncAnchorWithCompletionHandler(completionHandler func(currentAnchor FileProviderSyncAnchor))
	HasCurrentSyncAnchorWithCompletionHandler() bool

	// optional
	Invalidate()
	HasInvalidate() bool
}

A protocol for enumerating items and changes. Full Topic

type PFileProviderIncrementalContentFetching

type PFileProviderIncrementalContentFetching interface {
	// optional
	FetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, existingContents foundation.URL, existingVersion FileProviderItemVersion, request FileProviderRequest, completionHandler func(fileContents foundation.URL, item objc.Object, error foundation.Error)) foundation.Progress
	HasFetchContentsForItemWithIdentifierVersionUsingExistingContentsAtURLExistingVersionRequestCompletionHandler() bool
}

Support for fetching changes to the item’s content. Full Topic

type PFileProviderItemDecorating

type PFileProviderItemDecorating interface {
	// optional
	Decorations() []FileProviderItemDecorationIdentifier
	HasDecorations() bool
}

Support for decorating items. Full Topic

type PFileProviderPartialContentFetching

type PFileProviderPartialContentFetching interface {
	// optional
	FetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, request FileProviderRequest, requestedRange foundation.Range, alignment uint, options FileProviderFetchContentsOptions, completionHandler func(fileContents foundation.URL, item objc.Object, retrievedRange foundation.Range, flags FileProviderMaterializationFlags, error foundation.Error)) foundation.Progress
	HasFetchPartialContentsForItemWithIdentifierVersionRequestMinimalRangeAligningToOptionsCompletionHandler() bool
}

Support for fetching part of a file’s content. Full Topic

type PFileProviderPendingSetEnumerator

type PFileProviderPendingSetEnumerator interface {
	// optional
	DomainVersion() FileProviderDomainVersion
	HasDomainVersion() bool

	// optional
	RefreshInterval() foundation.TimeInterval
	HasRefreshInterval() bool
}

A protocol for enumerating pending items. Full Topic

type PFileProviderReplicatedExtension

type PFileProviderReplicatedExtension interface {
	// optional
	ItemForIdentifierRequestCompletionHandler(identifier FileProviderItemIdentifier, request FileProviderRequest, completionHandler func(arg0 objc.Object, arg1 foundation.Error)) foundation.Progress
	HasItemForIdentifierRequestCompletionHandler() bool

	// optional
	MaterializedItemsDidChangeWithCompletionHandler(completionHandler func())
	HasMaterializedItemsDidChangeWithCompletionHandler() bool

	// optional
	Invalidate()
	HasInvalidate() bool

	// optional
	PendingItemsDidChangeWithCompletionHandler(completionHandler func())
	HasPendingItemsDidChangeWithCompletionHandler() bool

	// optional
	ModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler(item objc.Object, version FileProviderItemVersion, changedFields FileProviderItemFields, newContents foundation.URL, options FileProviderModifyItemOptions, request FileProviderRequest, completionHandler func(item objc.Object, stillPendingFields FileProviderItemFields, shouldFetchContent bool, error foundation.Error)) foundation.Progress
	HasModifyItemBaseVersionChangedFieldsContentsOptionsRequestCompletionHandler() bool

	// optional
	CreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler(itemTemplate objc.Object, fields FileProviderItemFields, url foundation.URL, options FileProviderCreateItemOptions, request FileProviderRequest, completionHandler func(createdItem objc.Object, stillPendingFields FileProviderItemFields, shouldFetchContent bool, error foundation.Error)) foundation.Progress
	HasCreateItemBasedOnTemplateFieldsContentsOptionsRequestCompletionHandler() bool

	// optional
	DeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler(identifier FileProviderItemIdentifier, version FileProviderItemVersion, options FileProviderDeleteItemOptions, request FileProviderRequest, completionHandler func(arg0 foundation.Error)) foundation.Progress
	HasDeleteItemWithIdentifierBaseVersionOptionsRequestCompletionHandler() bool

	// optional
	ImportDidFinishWithCompletionHandler(completionHandler func())
	HasImportDidFinishWithCompletionHandler() bool

	// optional
	InitWithDomain(domain FileProviderDomain) objc.Object
	HasInitWithDomain() bool

	// optional
	FetchContentsForItemWithIdentifierVersionRequestCompletionHandler(itemIdentifier FileProviderItemIdentifier, requestedVersion FileProviderItemVersion, request FileProviderRequest, completionHandler func(fileContents foundation.URL, item objc.Object, error foundation.Error)) foundation.Progress
	HasFetchContentsForItemWithIdentifierVersionRequestCompletionHandler() bool
}

A File Provider extension in which the system replicates the contents on disk. Full Topic

type PFileProviderServiceSource

type PFileProviderServiceSource interface {
	// optional
	MakeListenerEndpointAndReturnError(error unsafe.Pointer) foundation.XPCListenerEndpoint
	HasMakeListenerEndpointAndReturnError() bool

	// optional
	ServiceName() foundation.FileProviderServiceName
	HasServiceName() bool
}

A service that provides a custom communication channel between the host app and the File Provider extension. Full Topic

type PFileProviderServicing

type PFileProviderServicing interface {
	// optional
	SupportedServiceSourcesForItemIdentifierCompletionHandler(itemIdentifier FileProviderItemIdentifier, completionHandler func(arg0 []FileProviderServiceSourceObject, arg1 foundation.Error)) foundation.Progress
	HasSupportedServiceSourcesForItemIdentifierCompletionHandler() bool
}

Support for providing a custom service source. Full Topic

type PFileProviderTestingChildrenEnumeration

type PFileProviderTestingChildrenEnumeration interface {
	// optional
	ItemIdentifier() FileProviderItemIdentifier
	HasItemIdentifier() bool

	// optional
	Side() FileProviderTestingOperationSide
	HasSide() bool
}

An operation that lists a directory’s content. Full Topic

type PFileProviderTestingCollisionResolution

type PFileProviderTestingCollisionResolution interface {
	// optional
	Side() FileProviderTestingOperationSide
	HasSide() bool

	// optional
	RenamedItem() objc.Object
	HasRenamedItem() bool
}

An operation that resolves a collision by renaming the new item. Full Topic

type PFileProviderTestingContentFetch

type PFileProviderTestingContentFetch interface {
	// optional
	ItemIdentifier() FileProviderItemIdentifier
	HasItemIdentifier() bool

	// optional
	Side() FileProviderTestingOperationSide
	HasSide() bool
}

An operation that fetches an item’s content. Full Topic

type PFileProviderTestingCreation

type PFileProviderTestingCreation interface {
	// optional
	TargetSide() FileProviderTestingOperationSide
	HasTargetSide() bool

	// optional
	DomainVersion() FileProviderDomainVersion
	HasDomainVersion() bool

	// optional
	SourceItem() objc.Object
	HasSourceItem() bool
}

An operation that syncs the creation of the source item to the target location. Full Topic

type PFileProviderTestingDeletion

type PFileProviderTestingDeletion interface {
	// optional
	SourceItemIdentifier() FileProviderItemIdentifier
	HasSourceItemIdentifier() bool

	// optional
	TargetItemBaseVersion() FileProviderItemVersion
	HasTargetItemBaseVersion() bool

	// optional
	TargetItemIdentifier() FileProviderItemIdentifier
	HasTargetItemIdentifier() bool

	// optional
	TargetSide() FileProviderTestingOperationSide
	HasTargetSide() bool

	// optional
	DomainVersion() FileProviderDomainVersion
	HasDomainVersion() bool
}

An operation that syncs the deletion of the source item to the target location. Full Topic

type PFileProviderTestingIngestion

type PFileProviderTestingIngestion interface {
	// optional
	ItemIdentifier() FileProviderItemIdentifier
	HasItemIdentifier() bool

	// optional
	Side() FileProviderTestingOperationSide
	HasSide() bool

	// optional
	Item() objc.Object
	HasItem() bool
}

An operation that alerts the system to either local or remote storage changes. Full Topic

type PFileProviderTestingLookup

type PFileProviderTestingLookup interface {
	// optional
	ItemIdentifier() FileProviderItemIdentifier
	HasItemIdentifier() bool

	// optional
	Side() FileProviderTestingOperationSide
	HasSide() bool
}

An operation that looks up an item. Full Topic

type PFileProviderTestingModification

type PFileProviderTestingModification interface {
	// optional
	ChangedFields() FileProviderItemFields
	HasChangedFields() bool

	// optional
	TargetItemIdentifier() FileProviderItemIdentifier
	HasTargetItemIdentifier() bool

	// optional
	SourceItem() objc.Object
	HasSourceItem() bool

	// optional
	TargetSide() FileProviderTestingOperationSide
	HasTargetSide() bool

	// optional
	DomainVersion() FileProviderDomainVersion
	HasDomainVersion() bool

	// optional
	TargetItemBaseVersion() FileProviderItemVersion
	HasTargetItemBaseVersion() bool
}

An operation that syncs the modification of the source item to the target location. Full Topic

type PFileProviderTestingOperation

type PFileProviderTestingOperation interface {
	// optional
	AsContentFetch() FileProviderTestingContentFetchObject
	HasAsContentFetch() bool

	// optional
	AsDeletion() FileProviderTestingDeletionObject
	HasAsDeletion() bool

	// optional
	AsIngestion() FileProviderTestingIngestionObject
	HasAsIngestion() bool

	// optional
	AsCreation() FileProviderTestingCreationObject
	HasAsCreation() bool

	// optional
	AsCollisionResolution() FileProviderTestingCollisionResolutionObject
	HasAsCollisionResolution() bool

	// optional
	AsModification() FileProviderTestingModificationObject
	HasAsModification() bool

	// optional
	AsLookup() FileProviderTestingLookupObject
	HasAsLookup() bool

	// optional
	AsChildrenEnumeration() FileProviderTestingChildrenEnumerationObject
	HasAsChildrenEnumeration() bool

	// optional
	Type() FileProviderTestingOperationType
	HasType() bool
}

An operation that the system can schedule. Full Topic

type PFileProviderThumbnailing

type PFileProviderThumbnailing interface {
	// optional
	FetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler(itemIdentifiers []FileProviderItemIdentifier, size coregraphics.Size, perThumbnailCompletionHandler func(identifier FileProviderItemIdentifier, imageData []byte, error foundation.Error), completionHandler func(error foundation.Error)) foundation.Progress
	HasFetchThumbnailsForItemIdentifiersRequestedSizePerThumbnailCompletionHandlerCompletionHandler() bool
}

Support for item thumbnails. Full Topic

type PFileProviderUserInteractionSuppressing

type PFileProviderUserInteractionSuppressing interface {
	// optional
	IsInteractionSuppressedForIdentifier(suppressionIdentifier string) bool
	HasIsInteractionSuppressedForIdentifier() bool

	// optional
	SetInteractionSuppressedForIdentifier(suppression bool, suppressionIdentifier string)
	HasSetInteractionSuppressedForIdentifier() bool
}

Support for suppressing user-interaction alerts. Full Topic

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL