class MediaWiktory::Wikipedia::Actions::Options

Change preferences of the current user.

Usage:

“`ruby api.options.reset(value).perform # returns string with raw output # or api.options.reset(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

_change(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/actions/options.rb, line 51
def _change(value)
  merge(change: value.to_s, replace: false)
end
_resetkinds(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/options.rb, line 38
def _resetkinds(value)
  defined?(super) && super || ["registered", "registered-multiselect", "registered-checkmatrix", "userjs", "special", "unused", "all"].include?(value.to_s) && merge(resetkinds: value.to_s, replace: false)
end
change(*values) click to toggle source

List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., optionname|otheroption|…, the option will be reset to its default value. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 46
def change(*values)
  values.inject(self) { |res, val| res._change(val) }
end
optionname(value) click to toggle source

The name of the option that should be set to the value given by optionvalue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 59
def optionname(value)
  merge(optionname: value.to_s)
end
optionvalue(value) click to toggle source

The value for the option specified by optionname.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 67
def optionvalue(value)
  merge(optionvalue: value.to_s)
end
reset() click to toggle source

Resets preferences to the site defaults.

@return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 25
def reset()
  merge(reset: 'true')
end
resetkinds(*values) click to toggle source

List of types of options to reset when the reset option is set.

@param values [Array<String>] Allowed values: “registered”, “registered-multiselect”, “registered-checkmatrix”, “userjs”, “special”, “unused”, “all”. @return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 33
def resetkinds(*values)
  values.inject(self) { |res, val| res._resetkinds(val) or fail ArgumentError, "Unknown value for resetkinds: #{val}" }
end
token(value) click to toggle source

A “csrf” token retrieved from action=query&meta=tokens

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/options.rb, line 75
def token(value)
  merge(token: value.to_s)
end