module MediaWiktory::Wikipedia::Modules::Globalusage

Returns global image usage for a certain image.

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

_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/globalusage.rb, line 30
def _prop(value)
  defined?(super) && super || ["url", "pageid", "namespace"].include?(value.to_s) && merge(guprop: value.to_s, replace: false)
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/globalusage.rb, line 46
def continue(value)
  merge(gucontinue: value.to_s)
end
filterlocal() click to toggle source

Filter local usage of the file.

@return [self]

# File lib/mediawiktory/wikipedia/modules/globalusage.rb, line 53
def filterlocal()
  merge(gufilterlocal: 'true')
end
limit(value) click to toggle source

How many links to return.

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

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

Which properties to return:

@param values [Array<String>] Allowed values: “url” (Adds url), “pageid” (Adds page ID), “namespace” (Adds namespace ID). @return [self]

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