Module: MediaWiktory::Wikipedia::Modules::Globalusage

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

Overview

Returns global image usage for a certain image.

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) 


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

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

#filterlocal ⇒ self

Filter local usage of the file.

Returns:

  • (self) 


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

def filterlocal()
  merge(gufilterlocal: 'true')
end

#limit(value) ⇒ self

How many links to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#prop(*values) ⇒ self

Which properties to return:

Parameters:

  • values (Array<String>) —

    Allowed values: "url" (Adds url), "pageid" (Adds page ID), "namespace" (Adds namespace ID).

Returns:

  • (self) 


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

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