module MediaWiktory::Wikipedia::Modules::Globalallusers
Enumerate all global users.
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
@private
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 54 def _dir(value) defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(agudir: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 80 def _excludegroup(value) defined?(super) && super || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].include?(value.to_s) && merge(aguexcludegroup: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 67 def _group(value) defined?(super) && super || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].include?(value.to_s) && merge(agugroup: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 93 def _prop(value) defined?(super) && super || ["lockinfo", "groups", "existslocally"].include?(value.to_s) && merge(aguprop: value.to_s, replace: false) end
Direction to sort in.
@param value [String] One of “ascending”, “descending”. @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 49 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
Exclude users in given global groups.
@param values [Array<String>] Allowed values: “OTRS-member”, “abusefilter-helper”, “apihighlimits-requestor”, “captcha-exempt”, “delete-global”, “founder”, “global-bot”, “global-flow-create”, “global-interface-editor”, “global-ipblock-exempt”, “global-rollbacker”, “global-sysop”, “new-wikis-importer”, “oathauth-tester”, “ombudsman”, “recursive-export”, “staff”, “steward”, “sysadmin”, “wmf-ops-monitoring”, “wmf-researcher”. @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 75 def excludegroup(*values) values.inject(self) { |res, val| res._excludegroup(val) or fail ArgumentError, "Unknown value for excludegroup: #{val}" } end
The user name to start enumerating from.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 25 def from(value) merge(agufrom: value.to_s) end
Limit users to given global groups.
@param values [Array<String>] Allowed values: “OTRS-member”, “abusefilter-helper”, “apihighlimits-requestor”, “captcha-exempt”, “delete-global”, “founder”, “global-bot”, “global-flow-create”, “global-interface-editor”, “global-ipblock-exempt”, “global-rollbacker”, “global-sysop”, “new-wikis-importer”, “oathauth-tester”, “ombudsman”, “recursive-export”, “staff”, “steward”, “sysadmin”, “wmf-ops-monitoring”, “wmf-researcher”. @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 62 def group(*values) values.inject(self) { |res, val| res._group(val) or fail ArgumentError, "Unknown value for group: #{val}" } end
How many total user names to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 101 def limit(value) merge(agulimit: value.to_s) end
Search
for all users that begin with this value.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 41 def prefix(value) merge(aguprefix: value.to_s) end
What pieces of information to include:
@param values [Array<String>] Allowed values: “lockinfo” (Whether the user account is locked), “groups” (Lists global groups that the user is in. This uses more server resources and may return fewer results than the limit), “existslocally” (Adds the information if the user exists locally). @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 88 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
The user name to stop enumerating at.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/globalallusers.rb, line 33 def to(value) merge(aguto: value.to_s) end