Module: MediaWiktory::Wikipedia::Modules::Duplicatefiles

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

Overview

List all files that are duplicates of the given files based on hash values.

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/duplicatefiles.rb', line 33

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

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


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

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

#limit(value) ⇒ self

How many duplicate files to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#localonly ⇒ self

Look only for files in the local repository.

Returns:

  • (self) 


53
54
55
 
# File 'lib/mediawiktory/wikipedia/modules/duplicatefiles.rb', line 53

def localonly()
  merge(dflocalonly: 'true')
end