Class: MediaWiktory::Wikipedia::Actions::Strikevote

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

Overview

Allows admins to strike or unstrike a vote.

Usage:

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

#option(value) ⇒ self

Which action to take: strike or unstrike a vote.

Parameters:

  • value (String) —

    One of "strike" (Strike a vote (remove it from the count)), "unstrike" (Unstrike a vote (restore it to the count)).

Returns:

  • (self) 


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

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

#reason(value) ⇒ self

The reason for striking or unstriking the vote.

Parameters:

  • value (String)

Returns:

  • (self) 


39
40
41
 
# File 'lib/mediawiktory/wikipedia/actions/strikevote.rb', line 39

def reason(value)
  merge(reason: value.to_s)
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/strikevote.rb', line 55

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

#voteid(value) ⇒ self

The ID of the vote to be struck or unstruck.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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