module MediaWiktory::Wikipedia::Modules::Protectedtitles

List all titles protected from creation.

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

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 64
def _dir(value)
  defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(ptdir: value.to_s)
end
_level(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 43
def _level(value)
  defined?(super) && super || ["autoconfirmed", "extendedconfirmed", "templateeditor", "sysop"].include?(value.to_s) && merge(ptlevel: value.to_s, replace: false)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 30
def _namespace(value)
  defined?(super) && super || ["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"].include?(value.to_s) && merge(ptnamespace: value.to_s, replace: false)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 93
def _prop(value)
  defined?(super) && super || ["timestamp", "user", "userid", "comment", "parsedcomment", "expiry", "level"].include?(value.to_s) && merge(ptprop: value.to_s, replace: false)
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/protectedtitles.rb, line 101
def continue(value)
  merge(ptcontinue: value.to_s)
end
dir(value) click to toggle source

In which direction to enumerate:

@param value [String] One of “newer” (List oldest first. Note: ptstart has to be before ptend), “older” (List newest first (default). Note: ptstart has to be later than ptend). @return [self]

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

Stop listing at this protection timestamp.

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 80
def end(value)
  merge(ptend: value.iso8601)
end
level(*values) click to toggle source

Only list titles with these protection levels.

@param values [Array<String>] Allowed values: “autoconfirmed”, “extendedconfirmed”, “templateeditor”, “sysop”. @return [self]

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 38
def level(*values)
  values.inject(self) { |res, val| res._level(val) or fail ArgumentError, "Unknown value for level: #{val}" }
end
limit(value) click to toggle source

How many total pages to return.

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

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 51
def limit(value)
  merge(ptlimit: value.to_s)
end
namespace(*values) click to toggle source

Only list titles in these namespaces.

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

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 25
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
prop(*values) click to toggle source

Which properties to get:

@param values [Array<String>] Allowed values: “timestamp” (Adds the timestamp of when protection was added), “user” (Adds the user that added the protection), “userid” (Adds the user ID that added the protection), “comment” (Adds the comment for the protection), “parsedcomment” (Adds the parsed comment for the protection), “expiry” (Adds the timestamp of when the protection will be lifted), “level” (Adds the protection level). @return [self]

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 88
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end
start(value) click to toggle source

Start listing at this protection timestamp.

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/protectedtitles.rb, line 72
def start(value)
  merge(ptstart: value.iso8601)
end