module MediaWiktory::Wikipedia::Modules::Allusers

Enumerate all registered 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

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 54
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(audir: value.to_s)
end
_excludegroup(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 80
def _excludegroup(value)
  defined?(super) && super || ["bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor"].include?(value.to_s) && merge(auexcludegroup: value.to_s, replace: false)
end
_group(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 67
def _group(value)
  defined?(super) && super || ["bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor"].include?(value.to_s) && merge(augroup: value.to_s, replace: false)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 106
def _prop(value)
  defined?(super) && super || ["blockinfo", "groups", "implicitgroups", "rights", "editcount", "registration", "centralids"].include?(value.to_s) && merge(auprop: value.to_s, replace: false)
end
_rights(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 93
def _rights(value)
  defined?(super) && super || ["apihighlimits", "applychangetags", "autoconfirmed", "autocreateaccount", "autopatrol", "bigdelete", "block", "blockemail", "bot", "browsearchive", "changetags", "createaccount", "createpage", "createtalk", "delete", "deletechangetags", "deletedhistory", "deletedtext", "deletelogentry", "deleterevision", "edit", "editcontentmodel", "editinterface", "editprotected", "editmyoptions", "editmyprivateinfo", "editmyusercss", "editmyuserjs", "editmywatchlist", "editsemiprotected", "editusercss", "edituserjs", "hideuser", "import", "importupload", "ipblock-exempt", "managechangetags", "markbotedits", "mergehistory", "minoredit", "move", "movefile", "move-categorypages", "move-rootuserpages", "move-subpages", "nominornewtalk", "noratelimit", "override-export-depth", "pagelang", "patrol", "patrolmarks", "protect", "purge", "read", "reupload", "reupload-own", "reupload-shared", "rollback", "sendemail", "siteadmin", "suppressionlog", "suppressredirect", "suppressrevision", "unblockself", "undelete", "unwatchedpages", "upload", "upload_by_url", "userrights", "userrights-interwiki", "viewmyprivateinfo", "viewmywatchlist", "viewsuppressed", "writeapi", "spamblacklistlog", "tboverride", "tboverride-account", "titleblacklistlog", "gadgets-edit", "gadgets-definition-edit", "globalblock", "globalblock-whitelist", "globalblock-exempt", "securepoll-create-poll", "renameuser", "nuke", "torunblocked", "skipcaptcha", "override-antispoof", "centralauth-merge", "centralauth-unmerge", "centralauth-lock", "centralauth-oversight", "globalgrouppermissions", "globalgroupmembership", "centralauth-rename", "centralauth-usermerge", "abusefilter-modify", "abusefilter-log-detail", "abusefilter-view", "abusefilter-log", "abusefilter-private", "abusefilter-modify-restricted", "abusefilter-revert", "abusefilter-view-private", "abusefilter-log-private", "abusefilter-hidden-log", "abusefilter-hide-log", "abusefilter-modify-global", "massmessage", "vipsscaler-test", "ep-org", "ep-course", "ep-token", "ep-enroll", "ep-remstudent", "ep-online", "ep-campus", "ep-instructor", "ep-beonline", "ep-becampus", "ep-beinstructor", "ep-bereviewer", "ep-remreviewer", "ep-bulkdelorgs", "ep-bulkdelcourses", "ep-remarticle", "ep-addstudent", "usermerge", "mwoauthproposeconsumer", "mwoauthupdateownconsumer", "mwoauthmanageconsumer", "mwoauthsuppress", "mwoauthviewsuppressed", "mwoauthviewprivate", "mwoauthmanagemygrants", "oathauth-enable", "oathauth-api-all", "checkuser", "checkuser-log", "autoreviewrestore", "stablesettings", "review", "unreviewedpages", "movestable", "validate", "templateeditor", "editeditorprotected", "editextendedsemiprotected", "extendedconfirmed", "flow-create-board", "flow-edit-post", "flow-suppress", "flow-hide", "flow-delete", "viewdeletedfile", "autoreview", "transcode-reset", "transcode-status", "collectionsaveasuserpage", "collectionsaveascommunitypage"].include?(value.to_s) && merge(aurights: value.to_s, replace: false)
end
activeusers() click to toggle source

Only list users active in the last 30 days.

@return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 128
def activeusers()
  merge(auactiveusers: 'true')
end
attachedwiki(value) click to toggle source

With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 136
def attachedwiki(value)
  merge(auattachedwiki: value.to_s)
end
dir(value) click to toggle source

Direction to sort in.

@param value [String] One of “ascending”, “descending”. @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 49
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
excludegroup(*values) click to toggle source

Exclude users in the given groups.

@param values [Array<String>] Allowed values: “bot”, “sysop”, “bureaucrat”, “reviewer”, “steward”, “accountcreator”, “import”, “transwiki”, “ipblock-exempt”, “oversight”, “founder”, “rollbacker”, “autoreviewer”, “researcher”, “filemover”, “checkuser”, “templateeditor”, “massmessage-sender”, “extendedconfirmed”, “extendedmover”, “patroller”, “abusefilter”, “confirmed”, “epcoordinator”, “eponline”, “epcampus”, “epinstructor”. @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 75
def excludegroup(*values)
  values.inject(self) { |res, val| res._excludegroup(val) or fail ArgumentError, "Unknown value for excludegroup: #{val}" }
end
from(value) click to toggle source

The user name to start enumerating from.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 25
def from(value)
  merge(aufrom: value.to_s)
end
group(*values) click to toggle source

Only include users in the given groups.

@param values [Array<String>] Allowed values: “bot”, “sysop”, “bureaucrat”, “reviewer”, “steward”, “accountcreator”, “import”, “transwiki”, “ipblock-exempt”, “oversight”, “founder”, “rollbacker”, “autoreviewer”, “researcher”, “filemover”, “checkuser”, “templateeditor”, “massmessage-sender”, “extendedconfirmed”, “extendedmover”, “patroller”, “abusefilter”, “confirmed”, “epcoordinator”, “eponline”, “epcampus”, “epinstructor”. @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 62
def group(*values)
  values.inject(self) { |res, val| res._group(val) or fail ArgumentError, "Unknown value for group: #{val}" }
end
limit(value) click to toggle source

How many total user names to return.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 114
def limit(value)
  merge(aulimit: value.to_s)
end
prefix(value) click to toggle source

Search for all users that begin with this value.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 41
def prefix(value)
  merge(auprefix: value.to_s)
end
prop(*values) click to toggle source

Which pieces of information to include:

@param values [Array<String>] Allowed values: “blockinfo” (Adds the information about a current block on the user), “groups” (Lists groups that the user is in. This uses more server resources and may return fewer results than the limit), “implicitgroups” (Lists all the groups the user is automatically in), “rights” (Lists rights that the user has), “editcount” (Adds the edit count of the user), “registration” (Adds the timestamp of when the user registered if available (may be blank)), “centralids” (Adds the central IDs and attachment status for the user). @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 101
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end
rights(*values) click to toggle source

Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

@param values [Array<String>] Allowed values: “apihighlimits”, “applychangetags”, “autoconfirmed”, “autocreateaccount”, “autopatrol”, “bigdelete”, “block”, “blockemail”, “bot”, “browsearchive”, “changetags”, “createaccount”, “createpage”, “createtalk”, “delete”, “deletechangetags”, “deletedhistory”, “deletedtext”, “deletelogentry”, “deleterevision”, “edit”, “editcontentmodel”, “editinterface”, “editprotected”, “editmyoptions”, “editmyprivateinfo”, “editmyusercss”, “editmyuserjs”, “editmywatchlist”, “editsemiprotected”, “editusercss”, “edituserjs”, “hideuser”, “import”, “importupload”, “ipblock-exempt”, “managechangetags”, “markbotedits”, “mergehistory”, “minoredit”, “move”, “movefile”, “move-categorypages”, “move-rootuserpages”, “move-subpages”, “nominornewtalk”, “noratelimit”, “override-export-depth”, “pagelang”, “patrol”, “patrolmarks”, “protect”, “purge”, “read”, “reupload”, “reupload-own”, “reupload-shared”, “rollback”, “sendemail”, “siteadmin”, “suppressionlog”, “suppressredirect”, “suppressrevision”, “unblockself”, “undelete”, “unwatchedpages”, “upload”, “upload_by_url”, “userrights”, “userrights-interwiki”, “viewmyprivateinfo”, “viewmywatchlist”, “viewsuppressed”, “writeapi”, “spamblacklistlog”, “tboverride”, “tboverride-account”, “titleblacklistlog”, “gadgets-edit”, “gadgets-definition-edit”, “globalblock”, “globalblock-whitelist”, “globalblock-exempt”, “securepoll-create-poll”, “renameuser”, “nuke”, “torunblocked”, “skipcaptcha”, “override-antispoof”, “centralauth-merge”, “centralauth-unmerge”, “centralauth-lock”, “centralauth-oversight”, “globalgrouppermissions”, “globalgroupmembership”, “centralauth-rename”, “centralauth-usermerge”, “abusefilter-modify”, “abusefilter-log-detail”, “abusefilter-view”, “abusefilter-log”, “abusefilter-private”, “abusefilter-modify-restricted”, “abusefilter-revert”, “abusefilter-view-private”, “abusefilter-log-private”, “abusefilter-hidden-log”, “abusefilter-hide-log”, “abusefilter-modify-global”, “massmessage”, “vipsscaler-test”, “ep-org”, “ep-course”, “ep-token”, “ep-enroll”, “ep-remstudent”, “ep-online”, “ep-campus”, “ep-instructor”, “ep-beonline”, “ep-becampus”, “ep-beinstructor”, “ep-bereviewer”, “ep-remreviewer”, “ep-bulkdelorgs”, “ep-bulkdelcourses”, “ep-remarticle”, “ep-addstudent”, “usermerge”, “mwoauthproposeconsumer”, “mwoauthupdateownconsumer”, “mwoauthmanageconsumer”, “mwoauthsuppress”, “mwoauthviewsuppressed”, “mwoauthviewprivate”, “mwoauthmanagemygrants”, “oathauth-enable”, “oathauth-api-all”, “checkuser”, “checkuser-log”, “autoreviewrestore”, “stablesettings”, “review”, “unreviewedpages”, “movestable”, “validate”, “templateeditor”, “editeditorprotected”, “editextendedsemiprotected”, “extendedconfirmed”, “flow-create-board”, “flow-edit-post”, “flow-suppress”, “flow-hide”, “flow-delete”, “viewdeletedfile”, “autoreview”, “transcode-reset”, “transcode-status”, “collectionsaveasuserpage”, “collectionsaveascommunitypage”. @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 88
def rights(*values)
  values.inject(self) { |res, val| res._rights(val) or fail ArgumentError, "Unknown value for rights: #{val}" }
end
to(value) click to toggle source

The user name to stop enumerating at.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 33
def to(value)
  merge(auto: value.to_s)
end
witheditsonly() click to toggle source

Only list users who have made edits.

@return [self]

# File lib/mediawiktory/wikipedia/modules/allusers.rb, line 121
def witheditsonly()
  merge(auwitheditsonly: 'true')
end