Class: MediaWiktory::Wikipedia::Actions::Pagetriagetagging

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

Overview

Add tags to an article.

Usage:

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

#bottom(value) ⇒ self

The tagging text to be added to the bottom of an article.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#deletion ⇒ self

Whether or not the tagging is for a deletion nomination.

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/actions/pagetriagetagging.rb', line 57

def deletion()
  merge(deletion: 'true')
end

#note(value) ⇒ self

Personal note to page creators from reviewers.

Parameters:

  • value (String)

Returns:

  • (self) 


65
66
67
 
# File 'lib/mediawiktory/wikipedia/actions/pagetriagetagging.rb', line 65

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

#pageid(value) ⇒ self

The article for which to be tagged.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#taglist(*values) ⇒ self

Pipe-separated list of tags.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


73
74
75
 
# File 'lib/mediawiktory/wikipedia/actions/pagetriagetagging.rb', line 73

def taglist(*values)
  values.inject(self) { |res, val| res._taglist(val) }
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#top(value) ⇒ self

The tagging text to be added to the top of an article.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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