module MediaWiktory::Wikipedia::Modules::GWblistentityusage
Returns all pages that use the given entity IDs. _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-wblistentityusage.rb, line 30 def _aspect(value) defined?(super) && super || ["S", "L", "T", "X", "O"].include?(value.to_s) && merge(gwbeuaspect: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb, line 43 def _entities(value) merge(gwbeuentities: value.to_s, replace: false) end
Only return entity IDs that used this aspect.
@param values [Array<String>] Allowed values: “S”, “L”, “T”, “X”, “O”. @return [self]
# File lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb, line 25 def aspect(*values) values.inject(self) { |res, val| res._aspect(val) or fail ArgumentError, "Unknown value for aspect: #{val}" } end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb, line 59 def continue(value) merge(gwbeucontinue: value.to_s) end
Entities that have been used.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb, line 38 def entities(*values) values.inject(self) { |res, val| res._entities(val) } end
How many entity usages to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb, line 51 def limit(value) merge(gwbeulimit: value.to_s) end