class MediaWiktory::Wikipedia::Actions::Titleblacklist

Validate an article title, filename, or username against the TitleBlacklist.

Usage:

“`ruby api.titleblacklist.title(value).perform # returns string with raw output # or api.titleblacklist.title(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

_action(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/titleblacklist.rb, line 39
def _action(value)
  defined?(super) && super || ["create", "edit", "upload", "createtalk", "createpage", "move", "new-account"].include?(value.to_s) && merge(tbaction: value.to_s)
end
action(value) click to toggle source

The action to be checked.

@param value [String] One of “create”, “edit”, “upload”, “createtalk”, “createpage”, “move”, “new-account”. @return [self]

# File lib/mediawiktory/wikipedia/actions/titleblacklist.rb, line 34
def action(value)
  _action(value) or fail ArgumentError, "Unknown value for action: #{value}"
end
nooverride() click to toggle source

Don't try to override the titleblacklist.

@return [self]

# File lib/mediawiktory/wikipedia/actions/titleblacklist.rb, line 46
def nooverride()
  merge(tbnooverride: 'true')
end
title(value) click to toggle source

The string to validate against the blacklist.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/titleblacklist.rb, line 26
def title(value)
  merge(tbtitle: value.to_s)
end