module MediaWiktory::Wikipedia::Modules::GQuerypage

Get a list provided by a QueryPage-based special page. _Generator module: for fetching pages corresponding to request._

The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):

“`ruby api.query # returns Actions::Query

.prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
.limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

“`

All submodule's parameters are documented as its public methods, see below.

Public Instance Methods

_page(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-querypage.rb, line 30
def _page(value)
  defined?(super) && super || ["Ancientpages", "BrokenRedirects", "Deadendpages", "DoubleRedirects", "ListDuplicatedFiles", "Listredirects", "Lonelypages", "Longpages", "MediaStatistics", "Mostcategories", "Mostimages", "Mostinterwikis", "Mostlinkedcategories", "Mostlinkedtemplates", "Mostlinked", "Mostrevisions", "Fewestrevisions", "Shortpages", "Uncategorizedcategories", "Uncategorizedpages", "Uncategorizedimages", "Uncategorizedtemplates", "Unusedcategories", "Unusedimages", "Wantedcategories", "Wantedfiles", "Wantedpages", "Wantedtemplates", "Unwatchedpages", "Unusedtemplates", "Withoutinterwiki", "UnconnectedPages", "PagesWithBadges", "EntityUsage", "GadgetUsage", "MostGloballyLinkedFiles", "GloballyWantedFiles", "DisambiguationPages", "DisambiguationPageLinks"].include?(value.to_s) && merge(gqppage: value.to_s)
end
limit(value) click to toggle source

Number of results to return.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-querypage.rb, line 46
def limit(value)
  merge(gqplimit: value.to_s)
end
offset(value) click to toggle source

When more results are available, use this to continue.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-querypage.rb, line 38
def offset(value)
  merge(gqpoffset: value.to_s)
end
page(value) click to toggle source

The name of the special page. Note, this is case sensitive.

@param value [String] One of “Ancientpages”, “BrokenRedirects”, “Deadendpages”, “DoubleRedirects”, “ListDuplicatedFiles”, “Listredirects”, “Lonelypages”, “Longpages”, “MediaStatistics”, “Mostcategories”, “Mostimages”, “Mostinterwikis”, “Mostlinkedcategories”, “Mostlinkedtemplates”, “Mostlinked”, “Mostrevisions”, “Fewestrevisions”, “Shortpages”, “Uncategorizedcategories”, “Uncategorizedpages”, “Uncategorizedimages”, “Uncategorizedtemplates”, “Unusedcategories”, “Unusedimages”, “Wantedcategories”, “Wantedfiles”, “Wantedpages”, “Wantedtemplates”, “Unwatchedpages”, “Unusedtemplates”, “Withoutinterwiki”, “UnconnectedPages”, “PagesWithBadges”, “EntityUsage”, “GadgetUsage”, “MostGloballyLinkedFiles”, “GloballyWantedFiles”, “DisambiguationPages”, “DisambiguationPageLinks”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-querypage.rb, line 25
def page(value)
  _page(value) or fail ArgumentError, "Unknown value for page: #{value}"
end