Module: MediaWiktory::Wikipedia::Modules::Deletedrevisions

Defined in:
lib/mediawiktory/wikipedia/modules/deletedrevisions.rb

Overview

Get deleted revision information.

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

All submodule's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Instance Method Details

#contentformat(value) ⇒ self

Serialization format used for drvdifftotext and expected for output of content.

Parameters:

  • value (String) —

    One of "application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain".

Returns:

  • (self) 


98
99
100
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 98

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

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


164
165
166
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 164

def continue(value)
  merge(drvcontinue: value.to_s)
end

#diffto(value) ⇒ self

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

Parameters:

  • value (String)

Returns:

  • (self) 


75
76
77
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 75

def diffto(value)
  merge(drvdiffto: value.to_s)
end

#difftotext(value) ⇒ self

Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.

Parameters:

  • value (String)

Returns:

  • (self) 


83
84
85
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 83

def difftotext(value)
  merge(drvdifftotext: value.to_s)
end

#difftotextpst ⇒ self

Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.

Returns:

  • (self) 


90
91
92
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 90

def difftotextpst()
  merge(drvdifftotextpst: 'true')
end

#dir(value) ⇒ self

In which direction to enumerate:

Parameters:

  • value (String) —

    One of "newer" (List oldest first. Note: drvstart has to be before drvend), "older" (List newest first (default). Note: drvstart has to be later than drvend).

Returns:

  • (self) 


127
128
129
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 127

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

#end(value) ⇒ self

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

Parameters:

  • value (Time)

Returns:

  • (self) 


119
120
121
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 119

def end(value)
  merge(drvend: value.iso8601)
end

#excludeuser(value) ⇒ self

Don't list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


156
157
158
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 156

def excludeuser(value)
  merge(drvexcludeuser: value.to_s)
end

#expandtemplates ⇒ self

Expand templates in revision content (requires drvprop=content).

Returns:

  • (self) 


45
46
47
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 45

def expandtemplates()
  merge(drvexpandtemplates: 'true')
end

#generatexml ⇒ self

Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).

Returns:

  • (self) 


52
53
54
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 52

def generatexml()
  merge(drvgeneratexml: 'true')
end

#limit(value) ⇒ self

Limit how many revisions will be returned.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


38
39
40
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 38

def limit(value)
  merge(drvlimit: value.to_s)
end

#parse ⇒ self

Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.

Returns:

  • (self) 


59
60
61
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 59

def parse()
  merge(drvparse: 'true')
end

#prop(*values) ⇒ self

Which properties to get for each revision:

Parameters:

  • values (Array<String>) —

    Allowed values: "ids" (The ID of the revision), "flags" (Revision flags (minor)), "timestamp" (The timestamp of the revision), "user" (User that made the revision), "userid" (User ID of the revision creator), "size" (Length (bytes) of the revision), "sha1" (SHA-1 (base 16) of the revision), "contentmodel" (Content model ID of the revision), "comment" (Comment by the user for the revision), "parsedcomment" (Parsed comment by the user for the revision), "content" (Text of the revision), "tags" (Tags for the revision), "parsetree" (The XML parse tree of revision content (requires content model wikitext)).

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 25

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end

#section(value) ⇒ self

Only retrieve the content of this section number.

Parameters:

  • value (String)

Returns:

  • (self) 


67
68
69
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 67

def section(value)
  merge(drvsection: value.to_s)
end

#start(value) ⇒ self

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

Parameters:

  • value (Time)

Returns:

  • (self) 


111
112
113
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 111

def start(value)
  merge(drvstart: value.iso8601)
end

#tag(value) ⇒ self

Only list revisions tagged with this tag.

Parameters:

  • value (String)

Returns:

  • (self) 


140
141
142
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 140

def tag(value)
  merge(drvtag: value.to_s)
end

#user(value) ⇒ self

Only list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


148
149
150
 
# File 'lib/mediawiktory/wikipedia/modules/deletedrevisions.rb', line 148

def user(value)
  merge(drvuser: value.to_s)
end