Class: MediaWiktory::Wikipedia::Actions::Tokens

Inherits:
Get
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/tokens.rb

Overview

Get tokens for data-modifying actions.

Usage:

api.tokens.type(value).perform # returns string with raw output
# or
api.tokens.type(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

Methods inherited from Get

#perform

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

#type(*values) ⇒ self

Types of token to request.

Parameters:

  • values (Array<String>) —

    Allowed values: "block", "createaccount", "csrf", "delete", "deleteglobalaccount", "edit", "email", "import", "login", "move", "options", "patrol", "protect", "rollback", "setglobalaccountstatus", "unblock", "userrights", "watch".

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/tokens.rb', line 26

def type(*values)
  values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" }
end