module MediaWiktory::Wikipedia::Modules::GAllfileusages
List all file usages, including non-existing. _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-allfileusages.rb, line 77 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(gafdir: value.to_s) end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 25 def continue(value) merge(gafcontinue: value.to_s) end
The direction in which to list.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 72 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
The title of the file to start enumerating from.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 33 def from(value) merge(gaffrom: value.to_s) end
How many total items to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 64 def limit(value) merge(gaflimit: value.to_s) end
Search
for all file titles that begin with this value.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 49 def prefix(value) merge(gafprefix: value.to_s) end
The title of the file to stop enumerating at.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 41 def to(value) merge(gafto: value.to_s) end
Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.
@return [self]
# File lib/mediawiktory/wikipedia/modules/g-allfileusages.rb, line 56 def unique() merge(gafunique: 'true') end