module MediaWiktory::Wikipedia::Modules::Tokens
Gets tokens for data-modifying actions.
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
_type(value)
click to toggle source
@private
Calls superclass method
# File lib/mediawiktory/wikipedia/modules/tokens.rb, line 30 def _type(value) defined?(super) && super || ["createaccount", "csrf", "deleteglobalaccount", "login", "patrol", "rollback", "setglobalaccountstatus", "userrights", "watch"].include?(value.to_s) && merge(type: value.to_s, replace: false) end
type(*values)
click to toggle source
Types of token to request.
@param values [Array<String>] Allowed values: “createaccount”, “csrf”, “deleteglobalaccount”, “login”, “patrol”, “rollback”, “setglobalaccountstatus”, “userrights”, “watch”. @return [self]
# File lib/mediawiktory/wikipedia/modules/tokens.rb, line 25 def type(*values) values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" } end