| WikiSiteOpenSearchAsync(String, Int32, Int32, 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.SitesAssembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
Syntax public Task<IList<OpenSearchResultEntry>> OpenSearchAsync(
string searchExpression,
int maxCount,
int defaultNamespaceId,
OpenSearchOptions options
)
Public Function OpenSearchAsync (
searchExpression As String,
maxCount As Integer,
defaultNamespaceId As Integer,
options As OpenSearchOptions
) 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 returnValue As Task(Of IList(Of OpenSearchResultEntry))
returnValue = instance.OpenSearchAsync(searchExpression,
maxCount, defaultNamespaceId, options)
public:
Task<IList<OpenSearchResultEntry^>^>^ OpenSearchAsync(
String^ searchExpression,
int maxCount,
int defaultNamespaceId,
OpenSearchOptions options
)
member OpenSearchAsync :
searchExpression : string *
maxCount : int *
defaultNamespaceId : int *
options : OpenSearchOptions -> 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.
Return Value
TaskIListOpenSearchResultEntrySearch result.
See Also