Class: MediaWiktory::Wikipedia::Actions::Editmassmessagelist

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

Overview

Edit a mass message delivery list.

Usage:

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

#add(*values) ⇒ self

Titles to add to the list.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def add(*values)
  values.inject(self) { |res, val| res._add(val) }
end

#remove(*values) ⇒ self

Titles to remove from the list.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def remove(*values)
  values.inject(self) { |res, val| res._remove(val) }
end

#spamlist(value) ⇒ self

Title of the delivery list to update.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


60
61
62
 
# File 'lib/mediawiktory/wikipedia/actions/editmassmessagelist.rb', line 60

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