module MediaWiktory::Wikipedia::Modules::Users

Get information about a list of 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

_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/users.rb, line 30
def _prop(value)
  defined?(super) && super || ["blockinfo", "groups", "groupmemberships", "implicitgroups", "rights", "editcount", "registration", "emailable", "gender", "centralids", "cancreate"].include?(value.to_s) && merge(usprop: value.to_s, replace: false)
end
_token(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/users.rb, line 77
def _token(value)
  defined?(super) && super || ["userrights"].include?(value.to_s) && merge(ustoken: value.to_s, replace: false)
end
_userids(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/modules/users.rb, line 64
def _userids(value)
  merge(ususerids: value.to_s, replace: false)
end
_users(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/modules/users.rb, line 51
def _users(value)
  merge(ususers: value.to_s, replace: false)
end
attachedwiki(value) click to toggle source

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

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/users.rb, line 38
def attachedwiki(value)
  merge(usattachedwiki: value.to_s)
end
prop(*values) click to toggle source

Which pieces of information to include:

@param values [Array<String>] Allowed values: “blockinfo” (Tags if the user is blocked, by whom, and for what reason), “groups” (Lists all the groups each user belongs to), “groupmemberships” (Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership), “implicitgroups” (Lists all the groups a user is automatically a member of), “rights” (Lists all the rights each user has), “editcount” (Adds the user's edit count), “registration” (Adds the user's registration timestamp), “emailable” (Tags if the user can and wants to receive email through Special:Emailuser), “gender” (Tags the gender of the user. Returns “male”, “female”, or “unknown”), “centralids” (Adds the central IDs and attachment status for the user), “cancreate” (Indicates whether an account for valid but unregistered usernames can be created). @return [self]

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

Use action=query&meta=tokens instead.

@param values [Array<String>] Allowed values: “userrights”. @return [self]

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

A list of user IDs to obtain information for.

@param values [Array<Integer>] @return [self]

# File lib/mediawiktory/wikipedia/modules/users.rb, line 59
def userids(*values)
  values.inject(self) { |res, val| res._userids(val) }
end
users(*values) click to toggle source

A list of users to obtain information for.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/modules/users.rb, line 46
def users(*values)
  values.inject(self) { |res, val| res._users(val) }
end