module MediaWiktory::Wikipedia::Modules::GPageswithprop
List all pages using a given page property. _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
@private
# File lib/mediawiktory/wikipedia/modules/g-pageswithprop.rb, line 54 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(gpwpdir: value.to_s) end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-pageswithprop.rb, line 33 def continue(value) merge(gpwpcontinue: value.to_s) end
In which direction to sort.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/g-pageswithprop.rb, line 49 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
The maximum number of pages to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-pageswithprop.rb, line 41 def limit(value) merge(gpwplimit: value.to_s) end
Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-pageswithprop.rb, line 25 def propname(value) merge(gpwppropname: value.to_s) end