WikiSiteOpenSearchAsync(String, OpenSearchOptions) 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.Sites
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.4+fbadc980737ddc9bb67116900ecad57f84a0b241

Syntax

C++

Copy

public Task<IList<OpenSearchResultEntry>> OpenSearchAsync(
	string searchExpression,
	OpenSearchOptions options
)

Public Function OpenSearchAsync ( 
	searchExpression As String,
	options As OpenSearchOptions
) As Task(Of IList(Of OpenSearchResultEntry))

Dim instance As WikiSite
Dim searchExpression As String
Dim options As OpenSearchOptions

Dim returnValue As Task(Of IList(Of OpenSearchResultEntry))

returnValue = instance.OpenSearchAsync(searchExpression, 
	options)

public:
Task<IList<OpenSearchResultEntry^>^>^ OpenSearchAsync(
	String^ searchExpression, 
	OpenSearchOptions options
)

member OpenSearchAsync : 
        searchExpression : string * 
        options : OpenSearchOptions -> Task<IList<OpenSearchResultEntry>>

Parameters

searchExpression String: The beginning part of the title to be searched.
options OpenSearchOptions: Other options.

Return Value

TaskIListOpenSearchResultEntry
Search result.

Remarks

This overload will allow up to 20 results to be returned.

Reference

WikiSite Class

OpenSearchAsync Overload

WikiClientLibrary.Sites Namespace