ExtractsPropertyProvider Class

This is preliminary documentation and is subject to change.

Returns plain-text or limited HTML extracts of the given pages. action=query&prop=extracts (mw:Extension:TextExtracts#API)

Inheritance Hierarchy

SystemObject
WikiClientLibrary.Pages.Queries.PropertiesWikiPagePropertyProviderExtractsPropertyGroup
WikiClientLibrary.Pages.Queries.PropertiesExtractsPropertyProvider

Namespace: WikiClientLibrary.Pages.Queries.Properties
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e

Syntax

C++

Copy

public class ExtractsPropertyProvider : WikiPagePropertyProvider<ExtractsPropertyGroup>

Public Class ExtractsPropertyProvider
	Inherits WikiPagePropertyProvider(Of ExtractsPropertyGroup)

Dim instance As ExtractsPropertyProvider

public ref class ExtractsPropertyProvider : public WikiPagePropertyProvider<ExtractsPropertyGroup^>

type ExtractsPropertyProvider = 
    class
        inherit WikiPagePropertyProvider<ExtractsPropertyGroup>
    end

The ExtractsPropertyProvider type exposes the following members.

Constructors

	Name	Description
	ExtractsPropertyProvider	Initializes a new instance of the ExtractsPropertyProvider class

Top

Properties

	Name	Description
	AsPlainText	Return extracts as plain text instead of limited HTML.
	IntroductionOnly	Return only content before the first section.
	MaxCharacters	How many characters to return. Actual text returned might be slightly longer.
	MaxSentences	How many sentences to return.
	PropertyName	Gets the property name, when this property is needed to be included in the prop= parameter in the MediaWiki API request. (Overrides WikiPagePropertyProviderTPropertyName)

Top

Methods

	Name	Description
	EnumParameters	Enumerates the MediaWiki API request parameters for action=query request. (Overrides WikiPagePropertyProviderTEnumParameters(MediaWikiVersion))
	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)
	GetMaxPaginationSize	Gets the maximum allowed count of titles in each MediaWiki API request. (Overrides WikiPagePropertyProviderTGetMaxPaginationSize(MediaWikiVersion, Boolean))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParsePropertyGroup	Parses the properties from the givenaction=query JSON response. (Overrides WikiPagePropertyProviderTParsePropertyGroup(JsonObject))
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Reference

WikiClientLibrary.Pages.Queries.Properties Namespace