Module: MediaWiktory::Wikipedia::Modules::Mystashedfiles

Defined in:
lib/mediawiktory/wikipedia/modules/mystashedfiles.rb

Overview

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 Actions::Query and its submodules):

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.

Instance Method Summary collapse

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/mystashedfiles.rb', line 46

def continue(value)
  merge(msfcontinue: value.to_s)
end

#limit(value) ⇒ self

How many files to get.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


38
39
40
 
# File 'lib/mediawiktory/wikipedia/modules/mystashedfiles.rb', line 38

def limit(value)
  merge(msflimit: value.to_s)
end

#prop(*values) ⇒ self

Which properties to fetch for the files.

Parameters:

  • values (Array<String>) —

    Allowed values: "size" (Fetch the file size and image dimensions), "type" (Fetch the file's MIME type and media type).

Returns:

  • (self) 


25
26
27
 
# 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