module MediaWiktory::Wikipedia::Modules::Globalgroups
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 {MediaWiktory::Wikipedia::Actions::Query} and its submodules):
“`ruby 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.
Public Instance Methods
_prop(value)
click to toggle source
@private
Calls superclass method
# File lib/mediawiktory/wikipedia/modules/globalgroups.rb, line 30 def _prop(value) defined?(super) && super || ["rights"].include?(value.to_s) && merge(ggpprop: value.to_s, replace: false) end
prop(*values)
click to toggle source
What pieces of information to include.
@param values [Array<String>] Allowed values: “rights”. @return [self]
# 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