Module: MediaWiktory::Wikipedia::Modules::Langbacklinks

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

Overview

Find all pages that link to the given language link.

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) 


41
42
43
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 41

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

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


70
71
72
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 70

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

#lang(value) ⇒ self

Language for the language link.

Parameters:

  • value (String)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 25

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

#limit(value) ⇒ self

How many total pages to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 49

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

#prop(*values) ⇒ self

Which properties to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "lllang" (Adds the language code of the language link), "lltitle" (Adds the title of the language link).

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 57

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end

#title(value) ⇒ self

Language link to search for. Must be used with lbllang.

Parameters:

  • value (String)

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/langbacklinks.rb', line 33

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