Class: MediaWiktory::Wikipedia::Actions::Cxsuggestionlist

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

Overview

Manage the suggestion lists. Add suggestions to lists and remove them.

Usage:

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

#from(value) ⇒ self

The source language code.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#listaction(value) ⇒ self

Action to be performed on the list.

Parameters:

  • value (String) —

    One of "add", "remove".

Returns:

  • (self) 


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

def listaction(value)
  _listaction(value) or fail ArgumentError, "Unknown value for listaction: #{value}"
end

#listname(value) ⇒ self

Suggestion list name.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#titles(*values) ⇒ self

Page titles.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def titles(*values)
  values.inject(self) { |res, val| res._titles(val) }
end

#to(value) ⇒ self

The target language code.

Parameters:

  • value (String)

Returns:

  • (self) 


68
69
70
 
# File 'lib/mediawiktory/wikipedia/actions/cxsuggestionlist.rb', line 68

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


76
77
78
 
# File 'lib/mediawiktory/wikipedia/actions/cxsuggestionlist.rb', line 76

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