Module: MediaWiktory::Wikipedia::Modules::Iwbacklinks

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

Overview

Find all pages that link to the given interwiki 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/iwbacklinks.rb', line 41

def continue(value)
  merge(iwblcontinue: 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/iwbacklinks.rb', line 70

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

#limit(value) ⇒ self

How many total pages to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#prefix(value) ⇒ self

Prefix for the interwiki.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def prefix(value)
  merge(iwblprefix: value.to_s)
end

#prop(*values) ⇒ self

Which properties to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "iwprefix" (Adds the prefix of the interwiki), "iwtitle" (Adds the title of the interwiki).

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/modules/iwbacklinks.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

Interwiki link to search for. Must be used with iwblblprefix.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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