Module: MediaWiktory::Wikipedia::Modules::Imageusage

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

Overview

Find all pages that use the given image title.

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/imageusage.rb', line 41

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

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


62
63
64
 
# File 'lib/mediawiktory/wikipedia/modules/imageusage.rb', line 62

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

#filterredir(value) ⇒ self

How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.

Parameters:

  • value (String) —

    One of "all", "redirects", "nonredirects".

Returns:

  • (self) 


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

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

#limit(value) ⇒ self

How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


88
89
90
 
# File 'lib/mediawiktory/wikipedia/modules/imageusage.rb', line 88

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

#namespace(*values) ⇒ self

The namespace to enumerate.

Parameters:

  • values (Array<String>) —

    Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".

Returns:

  • (self) 


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

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

#pageid(value) ⇒ self

Page ID to search. Cannot be used together with iutitle.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

def pageid(value)
  merge(iupageid: value.to_s)
end

#redirect ⇒ self

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Returns:

  • (self) 


95
96
97
 
# File 'lib/mediawiktory/wikipedia/modules/imageusage.rb', line 95

def redirect()
  merge(iuredirect: 'true')
end

#title(value) ⇒ self

Title to search. Cannot be used together with iupageid.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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