Class: MediaWiktory::Wikipedia::Actions::Categorytree

Inherits:
Get
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/categorytree.rb

Overview

Internal module for the CategoryTree extension.

Usage:

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 Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Methods inherited from Get

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#category(value) ⇒ self

Title in the category namespace, prefix will be ignored if given.

Parameters:

  • value (String)

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/categorytree.rb', line 26

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

#options(value) ⇒ self

Options for the CategoryTree constructor as a JSON object. The depth option defaults to 1.

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/categorytree.rb', line 34

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