Class: MediaWiktory::Wikipedia::Actions::Reviewactivity

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

Overview

Advertise or de-advertise yourself as reviewing an unreviewed page or unreviewed changes.

Usage:

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

#oldid(value) ⇒ self

The ID of the revision being reviewed.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#previd(value) ⇒ self

The prior revision ID (for reviewing changes only).

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#reviewing(value) ⇒ self

Whether to advertise yourself as reviewing or no longer reviewing.

Parameters:

  • value (String) —

    One of "0", "1".

Returns:

  • (self) 


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

def reviewing(value)
  _reviewing(value) or fail ArgumentError, "Unknown value for reviewing: #{value}"
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


55
56
57
 
# File 'lib/mediawiktory/wikipedia/actions/reviewactivity.rb', line 55

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