Class: MediaWiktory::Wikipedia::Actions::Review

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

Overview

Review a revision by approving or de-approving it.

Usage:

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

#comment(value) ⇒ self

Comment for the review.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#revid(value) ⇒ self

The revision ID for which to set the flags.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def revid(value)
  merge(revid: 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/review.rb', line 34

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

#unapprove ⇒ self

If set, revision will be unapproved rather than approved.

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/actions/review.rb', line 49

def unapprove()
  merge(unapprove: 'true')
end