Class: Factorix::API::Image

Inherits:

Data

• Object
• Data
• Factorix::API::Image

Defined in:

lib/factorix/api/image.rb,
lib/factorix/api/image.rb,
sig/factorix/api/image.rbs

Overview

Image object from MOD Portal API

Represents a MOD screenshot or image

See Also:

• https://wiki.factorio.com/Mod_portal_API

Instance Attribute Summary

• #id ⇒ String readonly

  Image ID.

• #thumbnail ⇒ URI::HTTPS readonly

  Thumbnail URL.

• #url ⇒ URI::HTTPS readonly

  Full-size image URL.

Instance Method Summary

• #initialize(id:, thumbnail:, url:) ⇒ Image constructor

  Create Image from API response hash.

Constructor Details

#initialize(id:, thumbnail:, url:) ⇒ Image

Create Image from API response hash

Parameters:

• id (String) —

  image ID

• thumbnail (String) —

  thumbnail URL

• url (String) —

  full-size image URL

• id: (String)
• thumbnail: (String)
• url: (String)

# File 'lib/factorix/api/image.rb', line 28

def initialize(id:, thumbnail:, url:)
  thumbnail = URI(thumbnail)
  url = URI(url)
  super
end

Instance Attribute Details

#id ⇒ String (readonly)

Returns image ID.

Returns:

• (String) —

  image ID

# File 'lib/factorix/api/image.rb', line 15

def id
  @id
end

#thumbnail ⇒ URI::HTTPS (readonly)

Returns thumbnail URL.

Returns:

• (URI::HTTPS) —

  thumbnail URL

# File 'lib/factorix/api/image.rb', line 15

def thumbnail
  @thumbnail
end

#url ⇒ URI::HTTPS (readonly)

Returns full-size image URL.

Returns:

• (URI::HTTPS) —

  full-size image URL

# File 'lib/factorix/api/image.rb', line 15

def url
  @url
end