IStorageProviderSuggestionsHandler.Remove Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes an item from the cloud storage provider's suggestions of the given result kind.
Important
The Windows.Storage.Provider.IStorageProviderSuggestionsHandler API is part of a Limited Access Feature (see LimitedAccessFeatures class). For more information or to request an unlock token, please use the LAF Access Token Request Form.
public:
void Remove(StorageProviderResultKind kind, Platform::String ^ remoteFileId);void Remove(StorageProviderResultKind const& kind, winrt::hstring const& remoteFileId);public void Remove(StorageProviderResultKind kind, string remoteFileId);function remove(kind, remoteFileId)Public Sub Remove (kind As StorageProviderResultKind, remoteFileId As String)Parameters
The kind of item to remove.
- remoteFileId
-
String
Platform::String
winrt::hstring
The remote file ID of the item to remove. See StorageProviderSuggestionResult.RemoteFileId.
Remarks
After Remove is successfully called for an item, the cloud storage provider should ensure that the item is never returned in future calls to GetSuggestions for that result kind.
To support offline scenarios and improve reliability, the cloud storage provider should ensure that removed suggestions are cached locally and synchronized with any backing service once service connectivity is restored.
If the given StorageProviderResultKind is not supported by the cloud provider, they should no-op the API call.
The given remote file ID will be the same value as the System.StorageProviderFileIdentifier property for the item. The ID may not correspond to an item returned by a previous call to GetSuggestions. This can occur if the user interacts with an item in the provider's sync root (for example, hiding an item located in the provider's sync root that is already present in the local recents list).