module MediaWiktory::Wikipedia::Modules::Authmanagerinfo

Retrieve information about the current authentication status.

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

_messageformat(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 58
def _messageformat(value)
  defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(amimessageformat: value.to_s)
end
_requestsfor(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 38
def _requestsfor(value)
  defined?(super) && super || ["login", "login-continue", "create", "create-continue", "link", "link-continue", "change", "remove", "unlink"].include?(value.to_s) && merge(amirequestsfor: value.to_s)
end
mergerequestfields() click to toggle source

Merge field information for all authentication requests into one array.

@return [self]

# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 45
def mergerequestfields()
  merge(amimergerequestfields: 'true')
end
messageformat(value) click to toggle source

Format to use for returning messages.

@param value [String] One of “html”, “wikitext”, “raw”, “none”. @return [self]

# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 53
def messageformat(value)
  _messageformat(value) or fail ArgumentError, "Unknown value for messageformat: #{value}"
end
requestsfor(value) click to toggle source

Fetch information about the authentication requests needed for the specified authentication action.

@param value [String] One of “login”, “login-continue”, “create”, “create-continue”, “link”, “link-continue”, “change”, “remove”, “unlink”. @return [self]

# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 33
def requestsfor(value)
  _requestsfor(value) or fail ArgumentError, "Unknown value for requestsfor: #{value}"
end
securitysensitiveoperation(value) click to toggle source

Test whether the user's current authentication status is sufficient for the specified security-sensitive operation.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/authmanagerinfo.rb, line 25
def securitysensitiveoperation(value)
  merge(amisecuritysensitiveoperation: value.to_s)
end