apple.fileprovider.protocol

Interface NSFileProviderChangeObserver

public interface NSFileProviderChangeObserver

Method Summary

Modifier and Type	Method and Description
void	didDeleteItemsWithIdentifiers(NSArray<java.lang.String> deletedItemIdentifiers) Delete existing items.
void	didUpdateItems(NSArray<?> updatedItems) Send updates to existing items, or insert new items.
void	finishEnumeratingChangesUpToSyncAnchorMoreComing(NSData anchor, boolean moreComing) This method is used to complete a batch of changes.
void	finishEnumeratingWithError(NSError error) If the enumeration fails with NSFileProviderErrorSyncAnchorExpired, we will drop all cached data and start the enumeration over starting with sync anchor nil.

Method Detail

didDeleteItemsWithIdentifiers

void didDeleteItemsWithIdentifiers(NSArray<java.lang.String> deletedItemIdentifiers)

Delete existing items. No-op if the item was unknown.

didUpdateItems

void didUpdateItems(NSArray<?> updatedItems)

Send updates to existing items, or insert new items.

finishEnumeratingChangesUpToSyncAnchorMoreComing

void finishEnumeratingChangesUpToSyncAnchorMoreComing(NSData anchor,
                                                      boolean moreComing)

This method is used to complete a batch of changes. Follow the advice in -[NSFileProviderChangeObserver suggestedBatchSize] to determine when to call this method.

It is expected that the sync anchor passed here be different than the sync anchor that the enumeration started at, unless the client was already up to date on all the changes on the server, and didn't have any pending updates or deletions.

Additionally, if the client is up to date on all the changes on the server it should set moreComing to NO.

Sync anchor data is limited to 500 bytes. Setting a larger anchor has the same effect as calling finishEnumeratingWithError with an expired sync anchor error.

finishEnumeratingWithError

void finishEnumeratingWithError(NSError error)

If the enumeration fails with NSFileProviderErrorSyncAnchorExpired, we will drop all cached data and start the enumeration over starting with sync anchor nil.