Module: MediaWiktory::Wikipedia::Modules::Images

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

Overview

Returns all files contained on 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) 


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

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

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

#images(*values) ⇒ self

Only list these files. Useful for checking whether a certain page has a certain file.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def images(*values)
  values.inject(self) { |res, val| res._images(val) }
end

#limit(value) ⇒ self

How many files to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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