Module: MediaWiktory::Wikipedia::Modules::Globalgroups

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

Overview

Enumerate all global groups.

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

#prop(*values) ⇒ self

What pieces of information to include.

Parameters:

  • values (Array<String>) —

    Allowed values: "rights".

Returns:

  • (self) 


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

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