Class: MediaWiktory::Wikipedia::Actions::Thank

Inherits:
Post
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/thank.rb

Overview

Send a thank-you notification to an editor.

Usage:

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

#rev(value) ⇒ self

Revision ID to thank someone for.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#source(value) ⇒ self

A short string describing the source of the request, for example diff or history.

Parameters:

  • value (String)

Returns:

  • (self) 


42
43
44
 
# File 'lib/mediawiktory/wikipedia/actions/thank.rb', line 42

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/thank.rb', line 34

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