Module: MediaWiktory::Wikipedia::Modules::Watchlistraw

Defined in:
lib/mediawiktory/wikipedia/modules/watchlistraw.rb

Overview

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 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

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 25

def continue(value)
  merge(wrcontinue: value.to_s)
end

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


96
97
98
 
# 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) ⇒ self

Title (with namespace prefix) to begin enumerating from.

Parameters:

  • value (String)

Returns:

  • (self) 


109
110
111
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 109

def fromtitle(value)
  merge(wrfromtitle: value.to_s)
end

#limit(value) ⇒ self

How many total results to return per request.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 46

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

#namespace(*values) ⇒ self

Only list pages in the given namespaces.

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) 


33
34
35
 
# 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) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


80
81
82
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 80

def owner(value)
  merge(wrowner: value.to_s)
end

#prop(*values) ⇒ self

Which additional properties to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "changed" (Adds timestamp of when the user was last notified about the edit).

Returns:

  • (self) 


54
55
56
 
# 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) ⇒ self

Only list items that meet these criteria.

Parameters:

  • values (Array<String>) —

    Allowed values: "changed", "!changed".

Returns:

  • (self) 


67
68
69
 
# 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) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


88
89
90
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 88

def token(value)
  merge(wrtoken: value.to_s)
end

#totitle(value) ⇒ self

Title (with namespace prefix) to stop enumerating at.

Parameters:

  • value (String)

Returns:

  • (self) 


117
118
119
 
# File 'lib/mediawiktory/wikipedia/modules/watchlistraw.rb', line 117

def totitle(value)
  merge(wrtotitle: value.to_s)
end