Package apple.fileprovider

Class NSFileProviderDomain

  • All Implemented Interfaces:
    NSObject
    public class NSFileProviderDomain
extends NSObject
    File provider domain. A file provider domain can be used to represent accounts or different locations exposed within a given file provider. Domains can be registered to the system using [@c] -[NSFileProviderMananger addDomain:completionHandler:] By default, a file provider extension does not have any domain. On the extension side, a separate instance of NSFileProviderExtension will be created for each @c NSFileProviderDomain registered. In that case, the [@c] NSFileProviderExtension.domain properties will indicate which domain the NSFileProviderExtension belongs to (or nil if none). All the files on disk belonging to the same domain must be grouped inside a common directory. That directory path is indicated by the [@p] pathRelativeToDocumentStorage property. API-Since: 11.0

    • Constructor Detail

      • NSFileProviderDomain

        protected NSFileProviderDomain​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static NSFileProviderDomain allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • displayName

        @NotNull
public @NotNull java.lang.String displayName()
        The display name shown by the system to represent this domain.

      • hash_static

        public static long hash_static()

      • identifier

        @NotNull
public @NotNull java.lang.String identifier()
        The identifier - as provided by the file provider extension.

      • initWithIdentifierDisplayNamePathRelativeToDocumentStorage

        public NSFileProviderDomain initWithIdentifierDisplayNamePathRelativeToDocumentStorage​(@NotNull
                                                                                       @NotNull java.lang.String identifier,
                                                                                       @NotNull
                                                                                       @NotNull java.lang.String displayName,
                                                                                       @NotNull
                                                                                       @NotNull java.lang.String pathRelativeToDocumentStorage)
        Initialize a new non-replicated NSFileProviderDomain The extension will be implementing NSFileProviderExtension. The file provider extension implementation can pick any @c identifier as it sees fit to identify the group of items. The identifier must not contain any characters from this set: [/:] [@c] NSFileProviderExtension.documentStorageURL. API-Since: 11.0
        Parameters:
        displayName - a user visible string representing the group of items the file provider extension is using.
        pathRelativeToDocumentStorage - a path relative to

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • pathRelativeToDocumentStorage

        @NotNull
public @NotNull java.lang.String pathRelativeToDocumentStorage()
        The path relative to the document storage of the file provider extension. Files belonging to this domains should be stored under this path. API-Since: 11.0

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • backingStoreIdentity

        @Nullable
public @Nullable NSData backingStoreIdentity()
        Identity of the backing store of the domain on the system. This property only applies for extensions that implement NSFileProviderReplicatedExtension. This provides an identifier that uniquely identifies the backing store used by the system for the domain. When this identifier has changed, the system has dropped its backing store and is building a new one. The system may decide to rebuild its backing store if it got corrupted. The backing store can also be rebuilt as a response to the provider calling `-[NSFileProviderManager reimportItemsBelowItemWithIdentifier:completionHandler:]`. It is guaranteed that calling reimport on the root item will cause the backing store to be rebuilt, but the system can also decide to do so when reimport is called on other items. When rebuilding the backing store, the system will invalidate any extension instance associated to that domain. As a consequence, the identity of the backing store associated with that domain is guaranteed to be stable for the lifetime of the NSFileProviderReplicatedExtension instance. API-Since: 16.0

      • initWithIdentifierDisplayName

        public NSFileProviderDomain initWithIdentifierDisplayName​(@NotNull
                                                          @NotNull java.lang.String identifier,
                                                          @NotNull
                                                          @NotNull java.lang.String displayName)
        Initialize a new replicated NSFileProviderDomain The extension will be implementing NSFileProviderReplicatedExtension. The file provider extension implementation can pick any @c identifier as it sees fit to identify the group of items. The identifier must not contain any characters from this set: [/:] In order to migrate a non-replicated domain to a replicated one, implementers have to make sure that they do not use the default domain, and then call +[NSFileProviderManager addDomain:completionHandler:] using the NSFileProviderDomain object returned by that init method. A domain with a specific identifier can be added multiple times; subsequent adds will update the properties of the existing domain. If a replicated domain is added "on top" of a non-replicated domain, the domain will be migrated to be replicated; existing bookmarks will remain valid, but the (externally visible) location of items will change to reflect the replicated location. It is not possible to migrate the default domain in this manner (since the default domain can not be added). It is recommended to migrate usage of the default domain to a domain with an explicit identifier instead.
        Parameters:
        displayName - a user visible string representing the group of items the file provider extension is using. API-Since: 16.0

      • isReplicated

        public boolean isReplicated()
        If the domain is a replicated domain. If set to YES, it means the domain is replicated. By default, on macOS, the value will always be YES. On iOS, it will depend on the way the NSFileProviderDomain object is contructed. Calling -[NSFileProviderDomain initWithIdentifier:displayName:] will initialize a replicated domain. -[NSFileProviderDomain initWithIdentifier:displayName:pathRelativeToDocumentStorage:] will initialize a non-replicated domain. To know whether a domain is replicated or not, users are advised to rely on the output of +[NSFileProviderManager getDomainsForProviderIdentifier:completionHandler:] API-Since: 16.0

      • setTestingModes

        public void setTestingModes​(long value)
        Testing modes. Testing modes are exposed as a means for the provider to have more control over the system in a testing environment. Enabling a testing mode alters the behavior of the system and enables some APIs for that mode. A process must have the com.apple.developer.fileprovider.testing-mode entitlement in order to configure a domain with non-empty testing modes. API-Since: 16.0

      • testingModes

        public long testingModes()
        Testing modes. Testing modes are exposed as a means for the provider to have more control over the system in a testing environment. Enabling a testing mode alters the behavior of the system and enables some APIs for that mode. A process must have the com.apple.developer.fileprovider.testing-mode entitlement in order to configure a domain with non-empty testing modes. API-Since: 16.0

      • userEnabled

        public boolean userEnabled()
        If user has disabled this domain from Files.app on iOS or System Settings on macOS, this will be set to NO. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.