module MediaWiktory::Wikipedia::Modules::Watchlistraw

Get all pages on the current user's watchlist.

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/watchlistraw.rb, line 101
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(wrdir: value.to_s)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 38
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(wrnamespace: value.to_s, replace: false)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 59
def _prop(value)
  defined?(super) && super || ["changed"].include?(value.to_s) && merge(wrprop: value.to_s, replace: false)
end
_show(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 72
def _show(value)
  defined?(super) && super || ["changed", "!changed"].include?(value.to_s) && merge(wrshow: 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/watchlistraw.rb, line 25
def continue(value)
  merge(wrcontinue: value.to_s)
end
dir(value) click to toggle source

The direction in which to list.

@param value [String] One of “ascending”, “descending”. @return [self]

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

Title (with namespace prefix) to begin enumerating from.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 109
def fromtitle(value)
  merge(wrfromtitle: value.to_s)
end
limit(value) click to toggle source

How many total results to return per request.

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

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

Only list pages in the given 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/watchlistraw.rb, line 33
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
owner(value) click to toggle source

Used along with wrtoken to access a different user's watchlist.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 80
def owner(value)
  merge(wrowner: value.to_s)
end
prop(*values) click to toggle source

Which additional properties to get:

@param values [Array<String>] Allowed values: “changed” (Adds timestamp of when the user was last notified about the edit). @return [self]

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

Only list items that meet these criteria.

@param values [Array<String>] Allowed values: “changed”, “!changed”. @return [self]

# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 67
def show(*values)
  values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
end
token(value) click to toggle source

A security token (available in the user's preferences) to allow access to another user's watchlist.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 88
def token(value)
  merge(wrtoken: value.to_s)
end
totitle(value) click to toggle source

Title (with namespace prefix) to stop enumerating at.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/watchlistraw.rb, line 117
def totitle(value)
  merge(wrtotitle: value.to_s)
end