Class: Discordrb::Attachment

Inherits:
Object
  • Object
show all
Includes:
IDObject
Defined in:
lib/discordrb/data/attachment.rb

Overview

An attachment to a message

Instance Attribute Summary collapse

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#filenameString (readonly)

Returns the attachment's filename.

Returns:

  • (String)

    the attachment's filename.


19
20
21
# File 'lib/discordrb/data/attachment.rb', line 19

def filename
  @filename
end

#heightInteger? (readonly)

Returns the height of an image file, in pixels, or nil if the file is not an image.

Returns:

  • (Integer, nil)

    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

#messageMessage (readonly)

Returns the message this attachment belongs to.

Returns:

  • (Message)

    the message this attachment belongs to.


9
10
11
# File 'lib/discordrb/data/attachment.rb', line 9

def message
  @message
end

#proxy_urlString (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.

Returns:

  • (String)

    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

#sizeInteger (readonly)

Returns the attachment's file size in bytes.

Returns:

  • (Integer)

    the attachment's file size in bytes.


22
23
24
# File 'lib/discordrb/data/attachment.rb', line 22

def size
  @size
end

#urlString (readonly)

Returns the CDN URL this attachment can be downloaded at.

Returns:

  • (String)

    the CDN URL this attachment can be downloaded at.


12
13
14
# File 'lib/discordrb/data/attachment.rb', line 12

def url
  @url
end

#widthInteger? (readonly)

Returns the width of an image file, in pixels, or nil if the file is not an image.

Returns:

  • (Integer, nil)

    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.

Returns:

  • (true, false)

    whether this file is an image file.


47
48
49
# File 'lib/discordrb/data/attachment.rb', line 47

def image?
  !(@width.nil? || @height.nil?)
end

#spoiler?true, false

Returns whether this file is tagged as a spoiler.

Returns:

  • (true, false)

    whether this file is tagged as a spoiler.


52
53
54
# File 'lib/discordrb/data/attachment.rb', line 52

def spoiler?
  @filename.start_with? 'SPOILER_'
end