module MediaWiktory::Wikipedia::Modules::Langlinks
Returns all interlanguage links from 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
@private
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 59 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(lldir: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 30 def _prop(value) defined?(super) && super || ["url", "langname", "autonym"].include?(value.to_s) && merge(llprop: 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/langlinks.rb, line 83 def continue(value) merge(llcontinue: value.to_s) end
The direction in which to list.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 54 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
Language code for localised language names.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 67 def inlanguagecode(value) merge(llinlanguagecode: value.to_s) end
Only return language links with this language code.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 38 def lang(value) merge(lllang: value.to_s) end
How many langlinks to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 75 def limit(value) merge(lllimit: value.to_s) end
Which additional properties to get for each interlanguage link:
@param values [Array<String>] Allowed values: “url” (Adds the full URL), “langname” (Adds the localised language name (best effort). Use llinlanguagecode to control the language), “autonym” (Adds the native language name). @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 25 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
Link to search for. Must be used with lllang.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 46 def title(value) merge(lltitle: value.to_s) end
Whether to get the full URL (cannot be used with llprop).
@return [self]
# File lib/mediawiktory/wikipedia/modules/langlinks.rb, line 90 def url() merge(llurl: 'true') end