Module: MediaWiktory::Wikipedia::Modules::Iwlinks

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

Overview

Returns all interwiki 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) 


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

def continue(value)
  merge(iwcontinue: 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/iwlinks.rb', line 54

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

#limit(value) ⇒ self

How many interwiki links to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#prefix(value) ⇒ self

Only return interwiki links with this prefix.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def prefix(value)
  merge(iwprefix: 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).

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/iwlinks.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

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

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#url ⇒ self

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

Returns:

  • (self) 


82
83
84
 
# File 'lib/mediawiktory/wikipedia/modules/iwlinks.rb', line 82

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