Class: MediaWiktory::Wikipedia::Actions::Cxtoken

Inherits:

Post

• Object
• Base
• Post
• MediaWiktory::Wikipedia::Actions::Cxtoken

Defined in:

lib/mediawiktory/wikipedia/actions/cxtoken.rb

Overview

Get JWT tokens to authenticate with cxserver.

Usage:

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

• #token(value) ⇒ self

  A "csrf" token retrieved from action=query&meta=tokens.

Methods inherited from Post

#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

#token(value) ⇒ self

A "csrf" token retrieved from action=query&meta=tokens

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/cxtoken.rb', line 26

def token(value)
  merge(token: value.to_s)
end