Class: MediaWiktory::Wikipedia::Actions::Patrol

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

Overview

Patrol a page or revision.

Usage:

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

#rcid(value) ⇒ self

Recentchanges ID to patrol.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#revid(value) ⇒ self

Revision ID to patrol.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#tags(*values) ⇒ self

Change tags to apply to the entry in the patrol log.

Parameters:

  • values (Array<String>) —

    Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".

Returns:

  • (self) 


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

def tags(*values)
  values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


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

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