Module: MediaWiktory::Wikipedia::Modules::Centralnoticelogs

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

Overview

Get a log of campaign configuration changes.

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

#campaign(value) ⇒ self

Campaign name (optional). Separate multiple values with a "|" (vertical bar).

Parameters:

  • value (String)

Returns:

  • (self) 


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

def campaign(value)
  merge(campaign: value.to_s)
end

#end(value) ⇒ self

End time of range (optional).

Parameters:

  • value (Time)

Returns:

  • (self) 


65
66
67
 
# File 'lib/mediawiktory/wikipedia/modules/centralnoticelogs.rb', line 65

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

#limit(value) ⇒ self

Maximum rows to return (optional).

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


41
42
43
 
# File 'lib/mediawiktory/wikipedia/modules/centralnoticelogs.rb', line 41

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

#offset(value) ⇒ self

Offset into result set (optional).

Parameters:

  • value (Integer)

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/modules/centralnoticelogs.rb', line 49

def offset(value)
  merge(offset: value.to_s)
end

#start(value) ⇒ self

Start time of range (optional).

Parameters:

  • value (Time)

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/modules/centralnoticelogs.rb', line 57

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

#user(value) ⇒ self

Username (optional).

Parameters:

  • value (String)

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/centralnoticelogs.rb', line 33

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