Class: MediaWiktory::Wikipedia::Actions::Filerevert

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

Overview

Revert a file to an old version.

Usage:

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

#archivename(value) ⇒ self

Archive name of the revision to revert to.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#comment(value) ⇒ self

Upload comment.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#filename(value) ⇒ self

Target filename, without the File: prefix.

Parameters:

  • value (String)

Returns:

  • (self) 


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

def filename(value)
  merge(filename: 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/filerevert.rb', line 50

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