module MediaWiktory::Wikipedia::Modules::Alllinks
Enumerate all links that point to a given namespace.
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/alllinks.rb, line 103 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(aldir: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 82 def _namespace(value) defined?(super) && super || ["-2", "-1", "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(alnamespace: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 69 def _prop(value) defined?(super) && super || ["ids", "title"].include?(value.to_s) && merge(alprop: 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/alllinks.rb, line 25 def continue(value) merge(alcontinue: value.to_s) end
The direction in which to list.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 98 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
The title of the link to start enumerating from.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 33 def from(value) merge(alfrom: value.to_s) end
How many total items to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 90 def limit(value) merge(allimit: value.to_s) end
The namespace to enumerate.
@param value [String] One of “-2”, “-1”, “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/alllinks.rb, line 77 def namespace(value) _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}" end
Search
for all linked titles that begin with this value.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 49 def prefix(value) merge(alprefix: value.to_s) end
Which pieces of information to include:
@param values [Array<String>] Allowed values: “ids” (Adds the page ID of the linking page (cannot be used with alunique)), “title” (Adds the title of the link). @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 64 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
The title of the link to stop enumerating at.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 41 def to(value) merge(alto: value.to_s) end
Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.
@return [self]
# File lib/mediawiktory/wikipedia/modules/alllinks.rb, line 56 def unique() merge(alunique: 'true') end