class MediaWiktory::Wikipedia::Actions::Strikevote

Allows admins to strike or unstrike a vote.

Usage:

“`ruby 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 {MediaWiktory::Wikipedia::Response} for working with action responses.

All action's parameters are documented as its public methods, see below.

Public Instance Methods

_option(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/strikevote.rb, line 31
def _option(value)
  defined?(super) && super || ["strike", "unstrike"].include?(value.to_s) && merge(option: value.to_s)
end
option(value) click to toggle source

Which action to take: strike or unstrike a vote.

@param value [String] One of “strike” (Strike a vote (remove it from the count)), “unstrike” (Unstrike a vote (restore it to the count)). @return [self]

# 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) click to toggle source

The reason for striking or unstriking the vote.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/strikevote.rb, line 39
def reason(value)
  merge(reason: value.to_s)
end
token(value) click to toggle source

A “csrf” token retrieved from action=query&meta=tokens

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/strikevote.rb, line 55
def token(value)
  merge(token: value.to_s)
end
voteid(value) click to toggle source

The ID of the vote to be struck or unstruck.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/actions/strikevote.rb, line 47
def voteid(value)
  merge(voteid: value.to_s)
end