LocalWikiSearchList Class

This is preliminary documentation and is subject to change.

A MediaWiki-list-like object that can enumerate the search results.

Inheritance Hierarchy

SystemObject
WikiClientLibrary.Wikia.WikiaApiLocalWikiSearchList

Namespace: WikiClientLibrary.Wikia.WikiaApi
Assembly: WikiClientLibrary.Wikia (in WikiClientLibrary.Wikia.dll) Version: 0.8.0+bba8b7a48c3412988f4331f41f4164c670d73663

Syntax

C++

Copy

public class LocalWikiSearchList : IWikiList<LocalWikiSearchResultItem>

Public Class LocalWikiSearchList
	Implements IWikiList(Of LocalWikiSearchResultItem)

Dim instance As LocalWikiSearchList

public ref class LocalWikiSearchList : IWikiList<LocalWikiSearchResultItem^>

type LocalWikiSearchList = 
    class
        interface IWikiList<LocalWikiSearchResultItem>
    end

The LocalWikiSearchList type exposes the following members.

Constructors

	Name	Description
	LocalWikiSearchList(WikiaSite)	Initializes a new instance of LocalWikiSearchList using the target Wikia site.
	LocalWikiSearchList(WikiaSite, String)	Initializes a new instance of LocalWikiSearchList using the target Wikia site and search keyword.

Top

Properties

	Name	Description
	Keyword	Search for all page titles (or content) that have this value.
	MinimumArticleQuality	Minimal value of article quality.
	NamespaceIds	Only list pages in these namespaces.
	PaginationSize	Gets/sets maximum items returned per API invocation.
	RankingType	The ranking to use in fetching the list of results.
	Site	Gets the Wikia site this list-like object is applied to.

Top

Methods

	Name	Description
	EnumItemsAsync	Asynchronously enumerates all the items in the list.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

To take a sequence of WikiPage instances from this object, you can use LINQ SelectTSource, TResult(IEnumerableTSource, FuncTSource, TResult) method with WikiPage(WikiSite, String); then call RefreshAsync(IEnumerableWikiPage) to fetch page information or content.

Reference

WikiClientLibrary.Wikia.WikiaApi Namespace

SearchGenerator