module MediaWiktory::Wikipedia::Modules::Wbentityusage

Returns all entity IDs used in the given pages.

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

_aspect(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 43
def _aspect(value)
  defined?(super) && super || ["S", "L", "T", "X", "O"].include?(value.to_s) && merge(wbeuaspect: value.to_s, replace: false)
end
_entities(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 56
def _entities(value)
  merge(wbeuentities: value.to_s, replace: false)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 30
def _prop(value)
  defined?(super) && super || ["url"].include?(value.to_s) && merge(wbeuprop: value.to_s, replace: false)
end
aspect(*values) click to toggle source

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/wbentityusage.rb, line 38
def aspect(*values)
  values.inject(self) { |res, val| res._aspect(val) or fail ArgumentError, "Unknown value for aspect: #{val}" }
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 72
def continue(value)
  merge(wbeucontinue: value.to_s)
end
entities(*values) click to toggle source

Only return page that used these entities.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 51
def entities(*values)
  values.inject(self) { |res, val| res._entities(val) }
end
limit(value) click to toggle source

How many entity usages to return.

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

# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 64
def limit(value)
  merge(wbeulimit: value.to_s)
end
prop(*values) click to toggle source

Properties to add to the result.

@param values [Array<String>] Allowed values: “url” (If enabled url of entity will be added). @return [self]

# File lib/mediawiktory/wikipedia/modules/wbentityusage.rb, line 25
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end