Class: MediaWiktory::Wikipedia::Actions::Resetpassword
- Defined in:
- lib/mediawiktory/wikipedia/actions/resetpassword.rb
Overview
Send a password reset email to a user.
Usage:
api.resetpassword.user(value).perform # returns string with raw output
# or
api.resetpassword.user(value).response # returns output parsed and wrapped into Response object
See Base for generic explanation of working with MediaWiki actions and Response for working with action responses.
All action's parameters are documented as its public methods, see below.
Instance Method Summary collapse
-
#email(value) ⇒ self
Email address of the user being reset.
-
#token(value) ⇒ self
A "csrf" token retrieved from action=query&meta=tokens.
-
#user(value) ⇒ self
User being reset.
Methods inherited from Post
Methods inherited from Base
#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url
Methods included from GlobalParams
#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang
Instance Method Details
#email(value) ⇒ self
Email address of the user being reset.
34 35 36 |
# File 'lib/mediawiktory/wikipedia/actions/resetpassword.rb', line 34 def email(value) merge(email: value.to_s) end |
#token(value) ⇒ self
A "csrf" token retrieved from action=query&meta=tokens
42 43 44 |
# File 'lib/mediawiktory/wikipedia/actions/resetpassword.rb', line 42 def token(value) merge(token: value.to_s) end |
#user(value) ⇒ self
User being reset.
26 27 28 |
# File 'lib/mediawiktory/wikipedia/actions/resetpassword.rb', line 26 def user(value) merge(user: value.to_s) end |