Module: MediaWiktory::Wikipedia::Modules::Langlinks

Defined in:
lib/mediawiktory/wikipedia/modules/langlinks.rb

Overview

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 Actions::Query and its submodules):

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.

Instance Method Summary collapse

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


83
84
85
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 83

def continue(value)
  merge(llcontinue: value.to_s)
end

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


54
55
56
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 54

def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end

#inlanguagecode(value) ⇒ self

Language code for localised language names.

Parameters:

  • value (String)

Returns:

  • (self) 


67
68
69
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 67

def inlanguagecode(value)
  merge(llinlanguagecode: value.to_s)
end

#lang(value) ⇒ self

Only return language links with this language code.

Parameters:

  • value (String)

Returns:

  • (self) 


38
39
40
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 38

def lang(value)
  merge(lllang: value.to_s)
end

#limit(value) ⇒ self

How many langlinks to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


75
76
77
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 75

def limit(value)
  merge(lllimit: value.to_s)
end

#prop(*values) ⇒ self

Which additional properties to get for each interlanguage link:

Parameters:

  • 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).

Returns:

  • (self) 


25
26
27
 
# 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

#title(value) ⇒ self

Link to search for. Must be used with lllang.

Parameters:

  • value (String)

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 46

def title(value)
  merge(lltitle: value.to_s)
end

#url ⇒ self

Whether to get the full URL (cannot be used with llprop).

Returns:

  • (self) 


90
91
92
 
# File 'lib/mediawiktory/wikipedia/modules/langlinks.rb', line 90

def url()
  merge(llurl: 'true')
end