 | WikiSiteOpenSearchAsync(String, Int32, Int32, OpenSearchOptions, CancellationToken) Method |
This is preliminary documentation and is subject to change.
Performs an opensearch and get results, often used for search box suggestions.
(MediaWiki 1.25 or OpenSearch extension)
Namespace: WikiClientLibrary.SitesAssembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.3+0a73c45f0c78941900e328c6c6b819597b665e00
Syntaxpublic Task<IList<OpenSearchResultEntry>> OpenSearchAsync(
string searchExpression,
int maxCount,
int defaultNamespaceId,
OpenSearchOptions options,
CancellationToken cancellationToken
)
Public Function OpenSearchAsync (
searchExpression As String,
maxCount As Integer,
defaultNamespaceId As Integer,
options As OpenSearchOptions,
cancellationToken As CancellationToken
) As Task(Of IList(Of OpenSearchResultEntry))
Dim instance As WikiSite
Dim searchExpression As String
Dim maxCount As Integer
Dim defaultNamespaceId As Integer
Dim options As OpenSearchOptions
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of IList(Of OpenSearchResultEntry))
returnValue = instance.OpenSearchAsync(searchExpression,
maxCount, defaultNamespaceId, options,
cancellationToken)
public:
Task<IList<OpenSearchResultEntry^>^>^ OpenSearchAsync(
String^ searchExpression,
int maxCount,
int defaultNamespaceId,
OpenSearchOptions options,
CancellationToken cancellationToken
)
member OpenSearchAsync :
searchExpression : string *
maxCount : int *
defaultNamespaceId : int *
options : OpenSearchOptions *
cancellationToken : CancellationToken -> Task<IList<OpenSearchResultEntry>>
Parameters
- searchExpression String
- The beginning part of the title to be searched.
- maxCount Int32
- Maximum number of results to return. No more than 500 (5000 for bots) allowed.
- defaultNamespaceId Int32
- Default namespace id to search. See BuiltInNamespaces for a list of possible namespace ids.
- options OpenSearchOptions
- Other options.
- cancellationToken CancellationToken
- The cancellation token that will be checked prior to completing the returned task.
Return Value
TaskIListOpenSearchResultEntrySearch result.
See Also