Module: MediaWiktory::Wikipedia::Modules::Allfileusages

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

Overview

List all file usages, including non-existing.

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) 


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

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

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


85
86
87
 
# File 'lib/mediawiktory/wikipedia/modules/allfileusages.rb', line 85

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

#from(value) ⇒ self

The title of the file to start enumerating from.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def from(value)
  merge(affrom: value.to_s)
end

#limit(value) ⇒ self

How many total items to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


77
78
79
 
# File 'lib/mediawiktory/wikipedia/modules/allfileusages.rb', line 77

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

#prefix(value) ⇒ self

Search for all file titles that begin with this value.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#prop(*values) ⇒ self

Which pieces of information to include:

Parameters:

  • values (Array<String>) —

    Allowed values: "ids" (Adds the page IDs of the using pages (cannot be used with afunique)), "title" (Adds the title of the file).

Returns:

  • (self) 


64
65
66
 
# File 'lib/mediawiktory/wikipedia/modules/allfileusages.rb', line 64

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

#to(value) ⇒ self

The title of the file to stop enumerating at.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def to(value)
  merge(afto: value.to_s)
end

#unique ⇒ self

Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.

Returns:

  • (self) 


56
57
58
 
# File 'lib/mediawiktory/wikipedia/modules/allfileusages.rb', line 56

def unique()
  merge(afunique: 'true')
end