Class: OnyxCord::Components::File

Inherits:

Object

• Object
• OnyxCord::Components::File

Defined in:

lib/onyxcord/models/component.rb

Overview

A component that allows you to display an attachment.

Instance Attribute Summary

• #id ⇒ Integer readonly

  The numeric identifier of the file.

• #media ⇒ MediaItem readonly

  The unfurled media item of the file.

• #name ⇒ String readonly

  The name of the file that was uploaded.

• #size ⇒ Integer readonly

  The size of the file that was uploaded in bytes.

• #spoiler ⇒ true, false (also: #spoiler?) readonly

  Whether or not the file should be blurred out.

Instance Attribute Details

#id ⇒ Integer (readonly)

Returns the numeric identifier of the file.

Returns:

• (Integer) —

  the numeric identifier of the file.

# File 'lib/onyxcord/models/component.rb', line 425

def id
  @id
end

#media ⇒ MediaItem (readonly)

Returns the unfurled media item of the file.

Returns:

• (MediaItem) —

  the unfurled media item of the file.

# File 'lib/onyxcord/models/component.rb', line 435

def media
  @media
end

#name ⇒ String (readonly)

Returns the name of the file that was uploaded.

Returns:

• (String) —

  the name of the file that was uploaded.

# File 'lib/onyxcord/models/component.rb', line 428

def name
  @name
end

#size ⇒ Integer (readonly)

Returns the size of the file that was uploaded in bytes.

Returns:

• (Integer) —

  the size of the file that was uploaded in bytes.

# File 'lib/onyxcord/models/component.rb', line 432

def size
  @size
end

#spoiler ⇒ true, false (readonly) Also known as: spoiler?

Returns whether or not the file should be blurred out.

Returns:

• (true, false) —

  whether or not the file should be blurred out.

# File 'lib/onyxcord/models/component.rb', line 439

def spoiler
  @spoiler
end