module MediaWiktory::Wikipedia::Modules::Backlinks

Find all pages that link to the given page.

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

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 67
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(bldir: value.to_s)
end
_filterredir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 80
def _filterredir(value)
  defined?(super) && super || ["all", "redirects", "nonredirects"].include?(value.to_s) && merge(blfilterredir: value.to_s)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 54
def _namespace(value)
  defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(blnamespace: 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/backlinks.rb, line 41
def continue(value)
  merge(blcontinue: value.to_s)
end
dir(value) click to toggle source

The direction in which to list.

@param value [String] One of “ascending”, “descending”. @return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 62
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
filterredir(value) click to toggle source

How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.

@param value [String] One of “all”, “redirects”, “nonredirects”. @return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 75
def filterredir(value)
  _filterredir(value) or fail ArgumentError, "Unknown value for filterredir: #{value}"
end
limit(value) click to toggle source

How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).

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

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 88
def limit(value)
  merge(bllimit: value.to_s)
end
namespace(*values) click to toggle source

The namespace to enumerate.

@param values [Array<String>] Allowed values: “0”, “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “100”, “101”, “108”, “109”, “118”, “119”, “446”, “447”, “710”, “711”, “828”, “829”, “2300”, “2301”, “2302”, “2303”. @return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 49
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
pageid(value) click to toggle source

Page ID to search. Cannot be used together with bltitle.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 33
def pageid(value)
  merge(blpageid: value.to_s)
end
redirect() click to toggle source

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

@return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 95
def redirect()
  merge(blredirect: 'true')
end
title(value) click to toggle source

Title to search. Cannot be used together with blpageid.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/backlinks.rb, line 25
def title(value)
  merge(bltitle: value.to_s)
end