TextPredictionGenerator.GetNextWordCandidatesAsync Method

Definition

Namespace:

Windows.Data.Text

Asynchronously retrieves a collection of strings containing next-word-prediction candidates.

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

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetNextWordCandidatesAsync(uint32_t const& maxCandidates, IIterable<winrt::hstring> const& previousStrings);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetNextWordCandidatesAsync(uint maxCandidates, IEnumerable<string> previousStrings);

function getNextWordCandidatesAsync(maxCandidates, previousStrings)

Public Function GetNextWordCandidatesAsync (maxCandidates As UInteger, previousStrings As IEnumerable(Of String)) As IAsyncOperation(Of IReadOnlyList(Of String))

Parameters

maxCandidates

UInt32

unsigned int

uint32_t

The maximum number of candidates to return.

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 next-word-prediction candidates.

Attributes

RemoteAsyncAttribute

Windows requirements

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