NSFileProviderExtension NSFileProviderExtension Class

Definition

Namespace:
UIKit UIKit
Assembly:
Xamarin.iOS.dll

Subclasses of NSFileProviderExtension implement the move and open functionality for extensions of type UIDocumentPickerViewController.

[Foundation.Register("NSFileProviderExtension", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class NSFileProviderExtension : Foundation.NSObject
type NSFileProviderExtension = class
    inherit NSObject
Inheritance
ObjectObject
NSObjectNSObject
NSFileProviderExtensionNSFileProviderExtension
Attributes
RegisterAttribute IntroducedAttribute UnavailableAttribute UnavailableAttribute

Remarks

(More documentation for this node is coming)

The members of this class can be used from a background thread.

Constructors

NSFileProviderExtension() NSFileProviderExtension()

Default constructor, initializes a new instance of this class.
NSFileProviderExtension(IntPtr) NSFileProviderExtension(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
NSFileProviderExtension(NSObjectFlag) NSFileProviderExtension(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
DocumentStorageUrl DocumentStorageUrl

Developers should not use this deprecated property. Developers should use 'FileProvider::NSFileProviderManager.DocumentStorageUrl' instead.
Domain Domain

When implemented by the developer, gets the domain that this file provider manages.
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
ProviderIdentifier ProviderIdentifier

When implemented by the developer, provides an identifier for reads and writes that are coordinated.
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
CreateDirectory(String, String, Action<INSFileProviderItem,NSError>) CreateDirectory(String, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, creates a new directory in the specified location and runs a handler when the operation is complete.
CreateDirectoryAsync(String, String) CreateDirectoryAsync(String, String)

When implemented by the developer, creates a new directory in the specified location and runs a handler when the operation is complete.
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DeleteItem(String, Action<NSError>) DeleteItem(String, Action<NSError>)

When implemented by the developer, deletes the identified item and runs a handler when the operation is complete.
DeleteItemAsync(String) DeleteItemAsync(String)

When implemented by the developer, deletes the identified item and runs a handler when the operation is complete.
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
FetchThumbnails(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler, Action<NSError>) FetchThumbnails(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler, Action<NSError>)

When implemented by the developer, fetches thumbnails for the specified item identifiers, runs the specified perThumbnailCompletionHandler for each thumbnail, and runs completionHandler when the entire operation is complete
FetchThumbnailsAsync(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler) FetchThumbnailsAsync(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler)

When implemented by the developer, fetches thumbnails for the specified item identifiers, runs the specified perThumbnailCompletionHandler for each thumbnail, and runs completionHandler when the entire operation is complete
FetchThumbnailsAsync(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler, NSProgress) FetchThumbnailsAsync(NSString[], CGSize, NSFileProviderExtensionFetchThumbnailsHandler, NSProgress)

When implemented by the developer, asynchronously fetches thumbnails for the specified item identifiers, runs the specified perThumbnailCompletionHandler for each thumbnail, and updates the progress result, returning a task that represents the operation.
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetEnumerator(String, NSError) GetEnumerator(String, NSError)

When implemented by the developer, returns an enumerator for the contents of the container.
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetItem(NSString, NSError) GetItem(NSString, NSError)

When implemented by the developer, returns the item for the identifier.
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetPersistentIdentifier(NSUrl) GetPersistentIdentifier(NSUrl)

When implemented by the developer, returns a specified identifier for a given URL.
GetPlaceholderUrl(NSUrl) GetPlaceholderUrl(NSUrl)

Returns the placeholder URL.
GetSupportedServiceSources(String, NSError) GetSupportedServiceSources(String, NSError)

When implemented by the developer, returns an array that contains the service sources that the app can use to perform actions on the identified item.
GetUrlForItem(String) GetUrlForItem(String)

When implemented by the developer, returns the URL for a specified persistent identifier.
ImportDocument(NSUrl, String, Action<INSFileProviderItem,NSError>) ImportDocument(NSUrl, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, imports the resource at the specified fileURL into the directory that is identified by parentItemIdentifier.
ImportDocumentAsync(NSUrl, String) ImportDocumentAsync(NSUrl, String)

When implemented by the developer, imports the resource at the specified fileURL into the directory that is identified by parentItemIdentifier.
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
ItemChangedAtUrl(NSUrl) ItemChangedAtUrl(NSUrl)

When implemented by the developer, informs a file provider extension that there has been a change in a document.
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
ProvidePlaceholderAtUrl(NSUrl, Action<NSError>) ProvidePlaceholderAtUrl(NSUrl, Action<NSError>)

When implemented by the developer, creates a specified placeholder for a previously defined URL.
ProvidePlaceholderAtUrlAsync(NSUrl) ProvidePlaceholderAtUrlAsync(NSUrl)

When implemented by the developer, creates a specified placeholder for a previously defined URL.
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RenameItem(String, String, Action<INSFileProviderItem,NSError>) RenameItem(String, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, changes the name of the identified item.
RenameItemAsync(String, String) RenameItemAsync(String, String)

When implemented by the developer, changes the name of the identified item.
ReparentItem(String, String, String, Action<INSFileProviderItem,NSError>) ReparentItem(String, String, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, moves the identified item to a new name under a new parent.
ReparentItemAsync(String, String, String) ReparentItemAsync(String, String, String)

When implemented by the developer, moves the identified item to a new name under a new parent.
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetFavoriteRank(NSNumber, String, Action<INSFileProviderItem,NSError>) SetFavoriteRank(NSNumber, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, sets the favorite rank of the identified directory.
SetFavoriteRankAsync(NSNumber, String) SetFavoriteRankAsync(NSNumber, String)

When implemented by the developer, sets the favorite rank of the identified directory.
SetLastUsedDate(NSDate, String, Action<INSFileProviderItem,NSError>) SetLastUsedDate(NSDate, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, sets the last used date for the identified item.
SetLastUsedDateAsync(NSDate, String) SetLastUsedDateAsync(NSDate, String)

When implemented by the developer, sets the last used date for the identified item.
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetTagData(NSData, String, Action<INSFileProviderItem,NSError>) SetTagData(NSData, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, sets the tag data on an item.
SetTagDataAsync(NSData, String) SetTagDataAsync(NSData, String)

When implemented by the developer, sets the tag data on an item.
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
StartProvidingItemAtUrl(NSUrl, Action<NSError>) StartProvidingItemAtUrl(NSUrl, Action<NSError>)

When implemented by the developer, supplies an actual file on a disk in place of a placeholder.
StartProvidingItemAtUrlAsync(NSUrl) StartProvidingItemAtUrlAsync(NSUrl)

When implemented by the developer, supplies an actual file on a disk in place of a placeholder.
StopProvidingItemAtUrl(NSUrl) StopProvidingItemAtUrl(NSUrl)

When implemented by the developer, informs a file provider extension when a specified document is no longer being accessed
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TrashItem(String, Action<INSFileProviderItem,NSError>) TrashItem(String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, moves the identified item into the trash.
TrashItemAsync(String) TrashItemAsync(String)

When implemented by the developer, moves the identified item into the trash.
UntrashItem(String, String, Action<INSFileProviderItem,NSError>) UntrashItem(String, String, Action<INSFileProviderItem,NSError>)

When implemented by the developer, restores the identified item from the trash.
UntrashItemAsync(String, String) UntrashItemAsync(String, String)

When implemented by the developer, restores the identified item from the trash.
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)
WritePlaceholder(NSUrl, NSDictionary, NSError) WritePlaceholder(NSUrl, NSDictionary, NSError)

Writes a placeholder using provided metadata.

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also