class MediaWiktory::Wikipedia::Actions::Createaccount
Create a new user account.
Usage:
“`ruby api.createaccount.requests(value).perform # returns string with raw output # or api.createaccount.requests(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/createaccount.rb, line 44 def _messageformat(value) defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(createmessageformat: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 31 def _requests(value) merge(createrequests: value.to_s, replace: false) end
This request is a continuation after an earlier UI or REDIRECT response. Either this or createreturnurl is required.
@return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 73 def continue() merge(createcontinue: 'true') end
Merge field information for all authentication requests into one array.
@return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 51 def mergerequestfields() merge(createmergerequestfields: 'true') end
Format to use for returning messages.
@param value [String] One of “html”, “wikitext”, “raw”, “none”. @return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 39 def messageformat(value) _messageformat(value) or fail ArgumentError, "Unknown value for messageformat: #{value}" end
Preserve state from a previous failed login attempt, if possible.
@return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 58 def preservestate() merge(createpreservestate: 'true') end
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 26 def requests(*values) values.inject(self) { |res, val| res._requests(val) } end
Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 66 def returnurl(value) merge(createreturnurl: value.to_s) end
A “createaccount” token retrieved from action=query&meta=tokens
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/createaccount.rb, line 81 def token(value) merge(createtoken: value.to_s) end