Module: MediaWiktory::Wikipedia::Modules::Tags

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

Overview

List change tags.

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/tags.rb', line 25

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

#limit(value) ⇒ self

The maximum number of tags to list.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#prop(*values) ⇒ self

Which properties to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "name" (Adds name of tag), "displayname" (Adds system message for the tag), "description" (Adds description of the tag), "hitcount" (Adds the number of revisions and log entries that have this tag), "defined" (Indicate whether the tag is defined), "source" (Gets the sources of the tag, which may include extension for extension-defined tags and manual for tags that may be applied manually by users), "active" (Whether the tag is still being applied).

Returns:

  • (self) 


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

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