Module: MediaWiktory::Wikipedia::Modules::GAlldeletedrevisions

Defined in:
lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb

Overview

List all deleted revisions by a user or in a namespace. 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

Instance Method Details

#contentformat(value) ⇒ self

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

Parameters:

  • value (String) —

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

Returns:

  • (self) 


85
86
87
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.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.

Parameters:

  • value (String)

Returns:

  • (self) 


188
189
190
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 188

def continue(value)
  merge(gadrcontinue: 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) 


62
63
64
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 62

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

#difftotext(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


70
71
72
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 70

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

#difftotextpst ⇒ self

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

Returns:

  • (self) 


77
78
79
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 77

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

#dir(value) ⇒ self

In which direction to enumerate:

Parameters:

  • value (String) —

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

Returns:

  • (self) 


135
136
137
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 135

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

#end(value) ⇒ self

The timestamp to stop enumerating at.

Parameters:

  • value (Time)

Returns:

  • (self) 


127
128
129
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 127

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

#excludeuser(value) ⇒ self

Don't list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


172
173
174
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 172

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

#expandtemplates ⇒ self

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

Returns:

  • (self) 


32
33
34
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 32

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

#from(value) ⇒ self

Start listing at this title.

Parameters:

  • value (String)

Returns:

  • (self) 


148
149
150
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 148

def from(value)
  merge(gadrfrom: value.to_s)
end

#generatetitles ⇒ self

When being used as a generator, generate titles rather than revision IDs.

Returns:

  • (self) 


195
196
197
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 195

def generatetitles()
  merge(gadrgeneratetitles: 'true')
end

#generatexml ⇒ self

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

Returns:

  • (self) 


39
40
41
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 39

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

#limit(value) ⇒ self

Limit how many revisions will be returned.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 25

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

#namespace(*values) ⇒ self

Only list pages in this namespace.

Parameters:

  • values (Array<String>) —

    Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".

Returns:

  • (self) 


106
107
108
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 106

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

#parse ⇒ self

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

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 46

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

#prefix(value) ⇒ self

Search for all page titles that begin with this value.

Parameters:

  • value (String)

Returns:

  • (self) 


164
165
166
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 164

def prefix(value)
  merge(gadrprefix: value.to_s)
end

#section(value) ⇒ self

Only retrieve the content of this section number.

Parameters:

  • value (String)

Returns:

  • (self) 


54
55
56
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 54

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

#start(value) ⇒ self

The timestamp to start enumerating from.

Parameters:

  • value (Time)

Returns:

  • (self) 


119
120
121
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 119

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

#tag(value) ⇒ self

Only list revisions tagged with this tag.

Parameters:

  • value (String)

Returns:

  • (self) 


180
181
182
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 180

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

#to(value) ⇒ self

Stop listing at this title.

Parameters:

  • value (String)

Returns:

  • (self) 


156
157
158
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 156

def to(value)
  merge(gadrto: value.to_s)
end

#user(value) ⇒ self

Only list revisions by this user.

Parameters:

  • value (String)

Returns:

  • (self) 


98
99
100
 
# File 'lib/mediawiktory/wikipedia/modules/g-alldeletedrevisions.rb', line 98

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