Module: MediaWiktory::Wikipedia::Modules::GDeletedrevisions
- Defined in:
- lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb
Overview
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 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
-
#contentformat(value) ⇒ self
Serialization format used for drvdifftotext and expected for output of content.
-
#continue(value) ⇒ self
When more results are available, use this to continue.
-
#diffto(value) ⇒ self
Revision ID to diff each revision to.
-
#difftotext(value) ⇒ self
Text to diff each revision to.
-
#difftotextpst ⇒ self
Perform a pre-save transform on the text before diffing it.
-
#dir(value) ⇒ self
In which direction to enumerate:.
-
#end(value) ⇒ self
The timestamp to stop enumerating at.
-
#excludeuser(value) ⇒ self
Don't list revisions by this user.
-
#expandtemplates ⇒ self
Expand templates in revision content (requires drvprop=content).
-
#generatexml ⇒ self
Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).
-
#limit(value) ⇒ self
Limit how many revisions will be returned.
-
#parse ⇒ self
Parse revision content (requires drvprop=content).
-
#section(value) ⇒ self
Only retrieve the content of this section number.
-
#start(value) ⇒ self
The timestamp to start enumerating from.
-
#tag(value) ⇒ self
Only list revisions tagged with this tag.
-
#user(value) ⇒ self
Only list revisions by this user.
Instance Method Details
#contentformat(value) ⇒ self
Serialization format used for drvdifftotext and expected for output of content.
85 86 87 |
# 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) ⇒ self
When more results are available, use this to continue.
151 152 153 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 151 def continue(value) merge(gdrvcontinue: 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.
62 63 64 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 62 def diffto(value) merge(gdrvdiffto: 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.
70 71 72 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 70 def difftotext(value) merge(gdrvdifftotext: value.to_s) end |
#difftotextpst ⇒ self
Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.
77 78 79 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 77 def difftotextpst() merge(gdrvdifftotextpst: 'true') end |
#dir(value) ⇒ self
In which direction to enumerate:
114 115 116 |
# 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) ⇒ self
The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
106 107 108 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 106 def end(value) merge(gdrvend: value.iso8601) end |
#excludeuser(value) ⇒ self
Don't list revisions by this user.
143 144 145 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 143 def excludeuser(value) merge(gdrvexcludeuser: value.to_s) end |
#expandtemplates ⇒ self
Expand templates in revision content (requires drvprop=content).
32 33 34 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 32 def () merge(gdrvexpandtemplates: 'true') end |
#generatexml ⇒ self
Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).
39 40 41 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 39 def generatexml() merge(gdrvgeneratexml: 'true') end |
#limit(value) ⇒ self
Limit how many revisions will be returned.
25 26 27 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 25 def limit(value) merge(gdrvlimit: 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.
46 47 48 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 46 def parse() merge(gdrvparse: 'true') end |
#section(value) ⇒ self
Only retrieve the content of this section number.
54 55 56 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 54 def section(value) merge(gdrvsection: value.to_s) end |
#start(value) ⇒ self
The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
98 99 100 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 98 def start(value) merge(gdrvstart: value.iso8601) end |
#tag(value) ⇒ self
Only list revisions tagged with this tag.
127 128 129 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 127 def tag(value) merge(gdrvtag: value.to_s) end |
#user(value) ⇒ self
Only list revisions by this user.
135 136 137 |
# File 'lib/mediawiktory/wikipedia/modules/g-deletedrevisions.rb', line 135 def user(value) merge(gdrvuser: value.to_s) end |