class MediaWiktory::Wikipedia::Actions::Userrights
Change a user's group membership.
Usage:
“`ruby api.userrights.user(value).perform # returns string with raw output # or api.userrights.user(value).response # returns output parsed and wrapped into Response
object “`
See {Base} for generic explanation of working with MediaWiki actions and {MediaWiktory::Wikipedia::Response} for working with action responses.
All action's parameters are documented as its public methods, see below.
Public Instance Methods
@private
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 47 def _add(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(add: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 60 def _expiry(value) merge(expiry: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 73 def _remove(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(remove: value.to_s, replace: false) end
Add the user to these groups, or if they are already a member, update the expiry of their membership in that group.
@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/actions/userrights.rb, line 42 def add(*values) values.inject(self) { |res, val| res._add(val) or fail ArgumentError, "Unknown value for add: #{val}" } end
Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 55 def expiry(*values) values.inject(self) { |res, val| res._expiry(val) } end
Reason for the change.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 81 def reason(value) merge(reason: value.to_s) end
Remove the user from these 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/actions/userrights.rb, line 68 def remove(*values) values.inject(self) { |res, val| res._remove(val) or fail ArgumentError, "Unknown value for remove: #{val}" } end
A “userrights” token retrieved from action=query&meta=tokens
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 89 def token(value) merge(token: value.to_s) end
User name.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 26 def user(value) merge(user: value.to_s) end
User ID.
@param value [Integer] @return [self]
# File lib/mediawiktory/wikipedia/actions/userrights.rb, line 34 def userid(value) merge(userid: value.to_s) end