Click or drag to resize

TransclusionsGenerator Class

This is preliminary documentation and is subject to change.

Generates pages from all pages (typically templates) transcluded in the provided page. (mw:API:Templates, MediaWiki 1.11+)
Inheritance Hierarchy

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0-int.8+f07259cca53448109bd542f6a3e53c54ddd48d58
Syntax
Copy
public class TransclusionsGenerator : WikiPagePropertyGenerator

The TransclusionsGenerator type exposes the following members.

Constructors
 NameDescription
Public methodTransclusionsGenerator(WikiSite)Initializes a new instance of the TransclusionsGenerator class
Public methodTransclusionsGenerator(WikiSite, WikiPageStub)Initializes a new instance of the TransclusionsGenerator class
Top
Properties
 NameDescription
Protected propertyDistinctGeneratedPages When using the default implementation of EnumPagesAsync(IWikiPageQueryProvider), determines whether to remove duplicate page results generated from generator results.
(Inherited from WikiPagePropertyGeneratorTItem)
Public propertyGeneratorName
(Inherited from WikiPagePropertyGeneratorTItem)
Public propertyMatchingTitles Only list transclusion to these titles. Useful for checking whether a certain page links to a certain title. (MediaWiki 1.17+)
Public propertyNamespaceIds Only list pages in these namespaces.
Public propertyOrderDescending Gets/sets a value that indicates whether the links should be listed in the descending order. (MediaWiki 1.19+)
Public propertyPageId Gets/sets the page ID from which to get the list-like property value.
(Inherited from WikiPagePropertyListT)
Public propertyPageTitle Gets/sets the page title from which to get the list-like property value.
(Inherited from WikiPagePropertyListT)
Public propertyPaginationSize Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiPagePropertyListT)
Public propertyPropertyName Gets the name of the property, used as the value of prop parameter in action=query request.
(Overrides WikiPagePropertyListTPropertyName)
Public propertySiteGets the MediaWiki site this instance applies to.
(Inherited from WikiPagePropertyListT)
Top
Methods
 NameDescription
Public methodEnumGeneratorParameters Fills generator parameters for action=query&generator= request.
(Inherited from WikiPagePropertyGeneratorTItem)
Public methodEnumItemsAsync Asynchronously enumerates all the items in the list.
(Inherited from WikiPagePropertyListT)
Public methodEnumListParameters When overridden, fills generator parameters for action=query&prop={PropertyName} request.
(Overrides WikiPagePropertyListTEnumListParameters)
Public methodEnumPagesAsync Asynchronously generate the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem)
Public methodEnumPagesAsync(IWikiPageQueryProvider) Asynchronously generates the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem)
Public methodEnumPagesAsync(PageQueryOptions) Asynchronously generates the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodItemFromJson Parses an item contained in the action=query&prop={PropertyName} JSON response.
(Inherited from WikiPagePropertyGenerator)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from WikiPagePropertyListT)
Top
See Also