Class: MediaWiktory::Wikipedia::Actions::ScribuntoConsole

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

Overview

Internal module for servicing XHR requests from the Scribunto console.

Usage:

api.scribunto-console.title(value).perform # returns string with raw output
# or
api.scribunto-console.title(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

#clear ⇒ self

Set to clear the current session state.

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/actions/scribunto-console.rb', line 57

def clear()
  merge(clear: 'true')
end

#content(value) ⇒ self

The new content of the module.

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/scribunto-console.rb', line 34

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

#question(value) ⇒ self

The next line to evaluate as a script.

Parameters:

  • value (String)

Returns:

  • (self) 


50
51
52
 
# File 'lib/mediawiktory/wikipedia/actions/scribunto-console.rb', line 50

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

#session(value) ⇒ self

Session token.

Parameters:

  • value (Integer)

Returns:

  • (self) 


42
43
44
 
# File 'lib/mediawiktory/wikipedia/actions/scribunto-console.rb', line 42

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

#title(value) ⇒ self

The title of the module to test.

Parameters:

  • value (String)

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/scribunto-console.rb', line 26

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