Class: MediaWiktory::Wikipedia::Actions::Massmessage

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

Overview

Send a message to a list of pages.

Usage:

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

#message(value) ⇒ self

Message body text.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#spamlist(value) ⇒ self

Page containing list of pages to leave a message on.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#subject(value) ⇒ self

Subject line of the message.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


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

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