module MediaWiktory::Wikipedia::Modules::Iwbacklinks
Find all pages that link to the given interwiki link.
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/iwbacklinks.rb, line 75 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(iwbldir: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 62 def _prop(value) defined?(super) && super || ["iwprefix", "iwtitle"].include?(value.to_s) && merge(iwblprop: value.to_s, replace: false) end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 41 def continue(value) merge(iwblcontinue: value.to_s) end
The direction in which to list.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 70 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
How many total pages to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 49 def limit(value) merge(iwbllimit: value.to_s) end
Prefix for the interwiki.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 25 def prefix(value) merge(iwblprefix: value.to_s) end
Which properties to get:
@param values [Array<String>] Allowed values: “iwprefix” (Adds the prefix of the interwiki), “iwtitle” (Adds the title of the interwiki). @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 57 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
Interwiki link to search for. Must be used with iwblblprefix.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/iwbacklinks.rb, line 33 def title(value) merge(iwbltitle: value.to_s) end