Module: MediaWiktory::Wikipedia::Modules::Stashimageinfo

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

Overview

Returns file information for stashed files.

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

#filekey(*values) ⇒ self

Key that identifies a previous upload that was stashed temporarily.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/stashimageinfo.rb', line 25

def filekey(*values)
  values.inject(self) { |res, val| res._filekey(val) }
end

#prop(*values) ⇒ self

Which file information to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "timestamp" (Adds timestamp for the uploaded version), "canonicaltitle" (Adds the canonical title of the file), "url" (Gives URL to the file and the description page), "size" (Adds the size of the file in bytes and the height, width and page count (if applicable)), "dimensions" (Alias for size), "sha1" (Adds SHA-1 hash for the file), "mime" (Adds MIME type of the file), "thumbmime" (Adds MIME type of the image thumbnail (requires url and param siiurlwidth)), "metadata" (Lists Exif metadata for the version of the file), "commonmetadata" (Lists file format generic metadata for the version of the file), "extmetadata" (Lists formatted metadata combined from multiple sources. Results are HTML formatted), "bitdepth" (Adds the bit depth of the version), "badfile" (Adds whether the file is on the MediaWiki:Bad image list).

Returns:

  • (self) 


51
52
53
 
# File 'lib/mediawiktory/wikipedia/modules/stashimageinfo.rb', line 51

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end

#sessionkey(*values) ⇒ self

Alias for siifilekey, for backward compatibility.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def sessionkey(*values)
  values.inject(self) { |res, val| res._sessionkey(val) }
end

#urlheight(value) ⇒ self

Similar to siiurlwidth.

Parameters:

  • value (Integer)

Returns:

  • (self) 


72
73
74
 
# File 'lib/mediawiktory/wikipedia/modules/stashimageinfo.rb', line 72

def urlheight(value)
  merge(siiurlheight: value.to_s)
end

#urlparam(value) ⇒ self

A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.

Parameters:

  • value (String)

Returns:

  • (self) 


80
81
82
 
# File 'lib/mediawiktory/wikipedia/modules/stashimageinfo.rb', line 80

def urlparam(value)
  merge(siiurlparam: value.to_s)
end

#urlwidth(value) ⇒ self

If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Parameters:

  • value (Integer)

Returns:

  • (self) 


64
65
66
 
# File 'lib/mediawiktory/wikipedia/modules/stashimageinfo.rb', line 64

def urlwidth(value)
  merge(siiurlwidth: value.to_s)
end