Class: MediaWiktory::Wikipedia::Actions::Abusefiltercheckmatch

Inherits:
Get
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/abusefiltercheckmatch.rb

Overview

Check to see if an AbuseFilter matches a set of variables, editor logged AbuseFilter event.

Usage:

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

#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

#filter(value) ⇒ self

The full filter text to check for a match.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#logid(value) ⇒ self

Abuse filter log ID to check against.

Parameters:

  • value (Integer)

Returns:

  • (self) 


50
51
52
 
# File 'lib/mediawiktory/wikipedia/actions/abusefiltercheckmatch.rb', line 50

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

#rcid(value) ⇒ self

Recent change ID to check against.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#vars(value) ⇒ self

JSON encoded array of variables to test against.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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