module MediaWiktory::Wikipedia::Modules::Mystashedfiles

Get a list of files in the current user's upload stash.

The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):

“`ruby 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.

Public Instance Methods

_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/mystashedfiles.rb, line 30
def _prop(value)
  defined?(super) && super || ["size", "type"].include?(value.to_s) && merge(msfprop: value.to_s, replace: false)
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/mystashedfiles.rb, line 46
def continue(value)
  merge(msfcontinue: value.to_s)
end
limit(value) click to toggle source

How many files to get.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/mystashedfiles.rb, line 38
def limit(value)
  merge(msflimit: value.to_s)
end
prop(*values) click to toggle source

Which properties to fetch for the files.

@param values [Array<String>] Allowed values: “size” (Fetch the file size and image dimensions), “type” (Fetch the file's MIME type and media type). @return [self]

# File lib/mediawiktory/wikipedia/modules/mystashedfiles.rb, line 25
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end