module MediaWiktory::Wikipedia::Modules::GDeletedrevisions

Get deleted revision information. _Generator module: for fetching pages corresponding to request._

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

“`ruby 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.

Public Instance Methods

_contentformat(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 90
def _contentformat(value)
  defined?(super) && super || ["application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain"].include?(value.to_s) && merge(gdrvcontentformat: value.to_s)
end
_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 119
def _dir(value)
  defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(gdrvdir: value.to_s)
end
contentformat(value) click to toggle source

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

@param value [String] One of “application/json”, “text/x-wiki”, “text/javascript”, “text/css”, “text/plain”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 85
def contentformat(value)
  _contentformat(value) or fail ArgumentError, "Unknown value for contentformat: #{value}"
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 151
def continue(value)
  merge(gdrvcontinue: value.to_s)
end
diffto(value) click to toggle source

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

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 62
def diffto(value)
  merge(gdrvdiffto: value.to_s)
end
difftotext(value) click to toggle source

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.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 70
def difftotext(value)
  merge(gdrvdifftotext: value.to_s)
end
difftotextpst() click to toggle source

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

@return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 77
def difftotextpst()
  merge(gdrvdifftotextpst: 'true')
end
dir(value) click to toggle source

In which direction to enumerate:

@param 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). @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 114
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
end(value) click to toggle source

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

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 106
def end(value)
  merge(gdrvend: value.iso8601)
end
excludeuser(value) click to toggle source

Don't list revisions by this user.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 143
def excludeuser(value)
  merge(gdrvexcludeuser: value.to_s)
end
expandtemplates() click to toggle source

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

@return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 32
def expandtemplates()
  merge(gdrvexpandtemplates: 'true')
end
generatexml() click to toggle source

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

@return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 39
def generatexml()
  merge(gdrvgeneratexml: 'true')
end
limit(value) click to toggle source

Limit how many revisions will be returned.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 25
def limit(value)
  merge(gdrvlimit: value.to_s)
end
parse() click to toggle source

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

@return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 46
def parse()
  merge(gdrvparse: 'true')
end
section(value) click to toggle source

Only retrieve the content of this section number.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 54
def section(value)
  merge(gdrvsection: value.to_s)
end
start(value) click to toggle source

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

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 98
def start(value)
  merge(gdrvstart: value.iso8601)
end
tag(value) click to toggle source

Only list revisions tagged with this tag.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 127
def tag(value)
  merge(gdrvtag: value.to_s)
end
user(value) click to toggle source

Only list revisions by this user.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb, line 135
def user(value)
  merge(gdrvuser: value.to_s)
end