Class: MediaWiktory::Wikipedia::Actions::Pagetriageaction

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

Overview

Mark an article as reviewed or unreviewed.

Usage:

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

#note(value) ⇒ self

Personal note to page creators from reviewers.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#pageid(value) ⇒ self

The article for which to be marked as reviewed or unreviewed.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#reviewed(value) ⇒ self

Whether the article is reviewed.

Parameters:

  • value (String) —

    One of "1", "0".

Returns:

  • (self) 


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

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

#skipnotif ⇒ self

Whether to skip notification.

Returns:

  • (self) 


62
63
64
 
# File 'lib/mediawiktory/wikipedia/actions/pagetriageaction.rb', line 62

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


47
48
49
 
# File 'lib/mediawiktory/wikipedia/actions/pagetriageaction.rb', line 47

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