C# Class WikiFunctions.Lists.Providers.ApiListProviderBase

Parent abstract class for all API-based providers currently simultaneous call of more than one API generator is not fully supported

Inheritance: IListProvider

Protected Properties

Property	Type	Description
WantedAttribute	string

Method	Description
ApiMakeList ( string url, int haveSoFar ) : List	Main function that retrieves the list from API, including paging
MakeList ( ) : List
Selected ( ) : void

Method	Description
ApiListProviderBase ( ) : System
EvaluateXmlElement ( XmlTextReader xml ) : bool	Allows for customised evaluation of the Xml element, as it is ok to add this element to the article list

protected ApiListProviderBase ( ) : System
return	System

Main function that retrieves the list from API, including paging

public ApiMakeList ( string url, int haveSoFar ) : List
url	string	URL of API request
haveSoFar	int	Number of pages already retrieved, for upper limit control
return	List

Allows for customised evaluation of the Xml element, as it is ok to add this element to the article list

protected EvaluateXmlElement ( XmlTextReader xml ) : bool
xml	System.Xml.XmlTextReader	XmlTextReader at which the current element is to be evaluated
return	bool

public abstract MakeList ( ) : List
return	List

public abstract Selected ( ) : void
return	void

protected string WantedAttribute
return	string