SearchSuggestionsRequestDeferral Class

Definition

Namespace:

Windows.ApplicationModel.Search

Enables the app to signal when it has finished populating a SearchSuggestionCollection object while handling the SuggestionsRequested event. Use a deferral if and only if your app needs to respond to a request for suggestions asynchronously.

public ref class SearchSuggestionsRequestDeferral sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SearchSuggestionsRequestDeferral final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SearchSuggestionsRequestDeferral

Public NotInheritable Class SearchSuggestionsRequestDeferral

Inheritance

Object Platform::Object IInspectable SearchSuggestionsRequestDeferral

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Important

To implement search in an app for Windows 10 or later, use AutoSuggestBox. See Auto-suggest box for more info.

You should not use Windows.ApplicationModel.Search APIs (SearchPane, SearchContract) or SearchBox APIs in apps for Windows 10 or later.

Your app should respond asynchronously to a request for suggestions if fulfilling the request will take a significant amount of time, such as fetching suggestions from a web service.

Use the Complete method to signal when your app has fulfilled the request. Retrieve this object by calling the GetDeferral method while handling the SuggestionsRequested event.

Methods

Complete()

Signals that the app has finished populating a SearchSuggestionCollection object while handling the SuggestionsRequested event.