Class: Discordrb::Attachment
- Inherits:
-
Object
- Object
- Discordrb::Attachment
- Includes:
- IDObject
- Defined in:
- lib/discordrb/data/attachment.rb
Overview
An attachment to a message
Instance Attribute Summary collapse
-
#content_type ⇒ String?
readonly
The attachment’s media type.
-
#description ⇒ String?
readonly
The attachment’s description.
-
#ephemeral ⇒ true, false
(also: #ephemeral?)
readonly
Whether this attachment is ephemeral.
-
#filename ⇒ String
readonly
The attachment’s filename.
-
#height ⇒ Integer?
readonly
The height of an image file, in pixels, or
nil
if the file is not an image. -
#message ⇒ Message
readonly
The message this attachment belongs to.
-
#proxy_url ⇒ String
readonly
The attachment’s proxy URL - I’m not sure what exactly this does, but I think it has something to do with CDNs.
-
#size ⇒ Integer
readonly
The attachment’s file size in bytes.
-
#url ⇒ String
readonly
The CDN URL this attachment can be downloaded at.
-
#width ⇒ Integer?
readonly
The width of an image file, in pixels, or
nil
if the file is not an image.
Attributes included from IDObject
Instance Method Summary collapse
-
#image? ⇒ true, false
Whether this file is an image file.
-
#spoiler? ⇒ true, false
Whether this file is tagged as a spoiler.
Methods included from IDObject
#==, #creation_time, synthesise
Instance Attribute Details
#content_type ⇒ String? (readonly)
Returns the attachment’s media type.
34 35 36 |
# File 'lib/discordrb/data/attachment.rb', line 34 def content_type @content_type end |
#description ⇒ String? (readonly)
Returns the attachment’s description.
31 32 33 |
# File 'lib/discordrb/data/attachment.rb', line 31 def description @description end |
#ephemeral ⇒ true, false (readonly) Also known as: ephemeral?
Returns whether this attachment is ephemeral.
37 38 39 |
# File 'lib/discordrb/data/attachment.rb', line 37 def ephemeral @ephemeral end |
#filename ⇒ String (readonly)
Returns the attachment’s filename.
19 20 21 |
# File 'lib/discordrb/data/attachment.rb', line 19 def filename @filename end |
#height ⇒ Integer? (readonly)
Returns the height of an image file, in pixels, or nil
if the file is not an image.
28 29 30 |
# File 'lib/discordrb/data/attachment.rb', line 28 def height @height end |
#message ⇒ Message (readonly)
Returns the message this attachment belongs to.
9 10 11 |
# File 'lib/discordrb/data/attachment.rb', line 9 def @message end |
#proxy_url ⇒ String (readonly)
Returns the attachment’s proxy URL - I’m not sure what exactly this does, but I think it has something to do with CDNs.
16 17 18 |
# File 'lib/discordrb/data/attachment.rb', line 16 def proxy_url @proxy_url end |
#size ⇒ Integer (readonly)
Returns the attachment’s file size in bytes.
22 23 24 |
# File 'lib/discordrb/data/attachment.rb', line 22 def size @size end |
#url ⇒ String (readonly)
Returns the CDN URL this attachment can be downloaded at.
12 13 14 |
# File 'lib/discordrb/data/attachment.rb', line 12 def url @url end |
#width ⇒ Integer? (readonly)
Returns the width of an image file, in pixels, or nil
if the file is not an image.
25 26 27 |
# File 'lib/discordrb/data/attachment.rb', line 25 def width @width end |
Instance Method Details
#image? ⇒ true, false
Returns whether this file is an image file.
62 63 64 |
# File 'lib/discordrb/data/attachment.rb', line 62 def image? !(@width.nil? || @height.nil?) end |
#spoiler? ⇒ true, false
Returns whether this file is tagged as a spoiler.
67 68 69 |
# File 'lib/discordrb/data/attachment.rb', line 67 def spoiler? @filename.start_with? 'SPOILER_' end |