Class: Discordrb::Embed

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

Overview

An Embed object that is contained in a message A freshly generated embed object will not appear in a message object unless grabbed from its ID in a channel.

Instance Attribute Summary collapse

Instance Attribute Details

#author ⇒ EmbedAuthor? (readonly)

Returns the author of the embed object. nil is there is not an author.

Returns:

  • (EmbedAuthor, nil) —

    the author of the embed object. nil is there is not an author



1459
1460
1461
 
# File 'lib/discordrb/data.rb', line 1459

def author
  @author
end

#description ⇒ String? (readonly)

Returns the description of the embed object. nil if there is not a description.

Returns:

  • (String, nil) —

    the description of the embed object. nil if there is not a description



1443
1444
1445
 
# File 'lib/discordrb/data.rb', line 1443

def description
  @description
end

#message ⇒ Message (readonly)

Returns the message this embed object is contained in.

Returns:

  • (Message) —

    the message this embed object is contained in.



1434
1435
1436
 
# File 'lib/discordrb/data.rb', line 1434

def message
  @message
end

#provider ⇒ EmbedProvider? (readonly)

Returns the provider of the embed object. nil is there is not a provider.

Returns:

  • (EmbedProvider, nil) —

    the provider of the embed object. nil is there is not a provider



1453
1454
1455
 
# File 'lib/discordrb/data.rb', line 1453

def provider
  @provider
end

#thumbnail ⇒ EmbedThumbnail? (readonly)

Returns the thumbnail of the embed object. nil is there is not a thumbnail.

Returns:

  • (EmbedThumbnail, nil) —

    the thumbnail of the embed object. nil is there is not a thumbnail



1456
1457
1458
 
# File 'lib/discordrb/data.rb', line 1456

def thumbnail
  @thumbnail
end

#title ⇒ String? (readonly)

Returns the title of the embed object. nil if there is not a title.

Returns:

  • (String, nil) —

    the title of the embed object. nil if there is not a title



1440
1441
1442
 
# File 'lib/discordrb/data.rb', line 1440

def title
  @title
end

#type ⇒ Symbol (readonly)

Returns the type of the embed object. Possible types are:

  • :link
  • :video
  • :image.

Returns:

  • (Symbol) —

    the type of the embed object. Possible types are:

    • :link
    • :video
    • :image


1450
1451
1452
 
# File 'lib/discordrb/data.rb', line 1450

def type
  @type
end

#url ⇒ String (readonly)

Returns the URL this embed object is based on.

Returns:

  • (String) —

    the URL this embed object is based on.



1437
1438
1439
 
# File 'lib/discordrb/data.rb', line 1437

def url
  @url
end