Module: MediaWiktory::Wikipedia::Modules::Gadgetcategories

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

Overview

Returns a list of gadget categories.

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

#names(*values) ⇒ self

Names of categories to retrieve.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def names(*values)
  values.inject(self) { |res, val| res._names(val) }
end

#prop(*values) ⇒ self

What gadget category information to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "name" (Internal category name), "title" (Category title), "members" (Number of gadgets in category).

Returns:

  • (self) 


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

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