TextPredictionGenerator.GetCandidatesAsync Method

Definition

Namespace:

Windows.Data.Text

Overloads

GetCandidatesAsync(String)	Asynchronously retrieves a list of candidate words based on the provided phonetic characters prefix.
GetCandidatesAsync(String, UInt32)	Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix.
GetCandidatesAsync(String, UInt32, TextPredictionOptions, IIterable<String>)	Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix and options.

GetCandidatesAsync(String)

Asynchronously retrieves a list of candidate words based on the provided phonetic characters prefix.

public:
 virtual IAsyncOperation<IVectorView<Platform::String ^> ^> ^ GetCandidatesAsync(Platform::String ^ input) = GetCandidatesAsync;

/// [Windows.Foundation.Metadata.Overload("GetCandidatesAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetCandidatesAsync(winrt::hstring const& input);

[Windows.Foundation.Metadata.Overload("GetCandidatesAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(string input);

function getCandidatesAsync(input)

Public Function GetCandidatesAsync (input As String) As IAsyncOperation(Of IReadOnlyList(Of String))

Parameters

input

String

Platform::String

winrt::hstring

The beginning phonetic characters of the words to be returned.

Returns

IAsyncOperation<IVectorView<String>>

IAsyncOperation<IReadOnlyList<String>>

IAsyncOperation<IVectorView<Platform::String>>

IAsyncOperation<IVectorView<winrt::hstring>>

An asynchronous operation object which, when it completes, contains an IVectorView of strings, which are the predicted words.

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• GetCandidatesAsync(String, UInt32)

GetCandidatesAsync(String, UInt32)

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix.

public:
 virtual IAsyncOperation<IVectorView<Platform::String ^> ^> ^ GetCandidatesAsync(Platform::String ^ input, unsigned int maxCandidates) = GetCandidatesAsync;

/// [Windows.Foundation.Metadata.Overload("GetCandidatesWithMaxCountAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetCandidatesAsync(winrt::hstring const& input, uint32_t const& maxCandidates);

[Windows.Foundation.Metadata.Overload("GetCandidatesWithMaxCountAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(string input, uint maxCandidates);

function getCandidatesAsync(input, maxCandidates)

Public Function GetCandidatesAsync (input As String, maxCandidates As UInteger) As IAsyncOperation(Of IReadOnlyList(Of String))

Parameters

input

String

Platform::String

winrt::hstring

The beginning phonetic characters of the words to be returned.

maxCandidates

UInt32

unsigned int

uint32_t

The maximum number of predicted words to return.

Returns

IAsyncOperation<IVectorView<String>>

IAsyncOperation<IReadOnlyList<String>>

IAsyncOperation<IVectorView<Platform::String>>

IAsyncOperation<IVectorView<winrt::hstring>>

An asynchronous operation object which, when it completes, contains an IVectorView of strings, which are the predicted words.

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• GetCandidatesAsync(String)

GetCandidatesAsync(String, UInt32, TextPredictionOptions, IIterable<String>)

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix and options.

public:
 virtual IAsyncOperation<IVectorView<Platform::String ^> ^> ^ GetCandidatesAsync(Platform::String ^ input, unsigned int maxCandidates, TextPredictionOptions predictionOptions, IIterable<Platform::String ^> ^ previousStrings) = GetCandidatesAsync;

/// [Windows.Foundation.Metadata.Overload("GetCandidatesWithParametersAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetCandidatesAsync(winrt::hstring const& input, uint32_t const& maxCandidates, TextPredictionOptions const& predictionOptions, IIterable<winrt::hstring> const& previousStrings);

[Windows.Foundation.Metadata.Overload("GetCandidatesWithParametersAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(string input, uint maxCandidates, TextPredictionOptions predictionOptions, IEnumerable<string> previousStrings);

function getCandidatesAsync(input, maxCandidates, predictionOptions, previousStrings)

Public Function GetCandidatesAsync (input As String, maxCandidates As UInteger, predictionOptions As TextPredictionOptions, previousStrings As IEnumerable(Of String)) As IAsyncOperation(Of IReadOnlyList(Of String))

Parameters

input

String

Platform::String

winrt::hstring

The beginning phonetic characters of the words to be returned.

maxCandidates

UInt32

unsigned int

uint32_t

The maximum number of predicted words to return.

predictionOptions

TextPredictionOptions

A TextPredictionOptions value containing prediction options.

previousStrings

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

A collection of previously input words (to assist text prediction).

Returns

IAsyncOperation<IVectorView<String>>

IAsyncOperation<IReadOnlyList<String>>

IAsyncOperation<IVectorView<Platform::String>>

IAsyncOperation<IVectorView<winrt::hstring>>

An asynchronous operation object which, when it completes, contains an IVectorView of strings, which are the predicted words.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v7.0)