class MediaWiktory::Wikipedia::Actions::Categorytree
Internal module for the CategoryTree extension.
Usage:
“`ruby api.categorytree.category(value).perform # returns string with raw output # or api.categorytree.category(value).response # returns output parsed and wrapped into Response
object “`
See {Base} for generic explanation of working with MediaWiki actions and {MediaWiktory::Wikipedia::Response} for working with action responses.
All action's parameters are documented as its public methods, see below.
Public Instance Methods
category(value)
click to toggle source
Title in the category namespace, prefix will be ignored if given.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/categorytree.rb, line 26 def category(value) merge(category: value.to_s) end
options(value)
click to toggle source
Options
for the CategoryTree constructor as a JSON object. The depth option defaults to 1.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/categorytree.rb, line 34 def options(value) merge(options: value.to_s) end