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

#authorEmbedAuthor? (readonly)

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

Returns:

  • (EmbedAuthor, nil)

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


2122
2123
2124
# File 'lib/discordrb/data.rb', line 2122

def author
  @author
end

#colorString? (readonly) Also known as: colour

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

Returns:

  • (String, nil)

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


2103
2104
2105
# File 'lib/discordrb/data.rb', line 2103

def color
  @color
end

#descriptionString? (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


2090
2091
2092
# File 'lib/discordrb/data.rb', line 2090

def description
  @description
end

#fieldsArray<EmbedField>? (readonly)

Returns the fields of the embed object. nil if there are no fields.

Returns:

  • (Array<EmbedField>, nil)

    the fields of the embed object. nil if there are no fields


2125
2126
2127
# File 'lib/discordrb/data.rb', line 2125

def fields
  @fields
end

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

Returns:

  • (EmbedFooter, nil)

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


2107
2108
2109
# File 'lib/discordrb/data.rb', line 2107

def footer
  @footer
end

#imageEmbedImage? (readonly)

Returns the image of the embed object. nil if there is not an image.

Returns:

  • (EmbedImage, nil)

    the image of the embed object. nil if there is not an image


2113
2114
2115
# File 'lib/discordrb/data.rb', line 2113

def image
  @image
end

#messageMessage (readonly)

Returns the message this embed object is contained in.

Returns:

  • (Message)

    the message this embed object is contained in.


2081
2082
2083
# File 'lib/discordrb/data.rb', line 2081

def message
  @message
end

#providerEmbedProvider? (readonly)

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

Returns:

  • (EmbedProvider, nil)

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


2110
2111
2112
# File 'lib/discordrb/data.rb', line 2110

def provider
  @provider
end

#thumbnailEmbedThumbnail? (readonly)

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

Returns:

  • (EmbedThumbnail, nil)

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


2116
2117
2118
# File 'lib/discordrb/data.rb', line 2116

def thumbnail
  @thumbnail
end

#timestampTime? (readonly)

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

Returns:

  • (Time, nil)

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


2100
2101
2102
# File 'lib/discordrb/data.rb', line 2100

def timestamp
  @timestamp
end

#titleString? (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


2087
2088
2089
# File 'lib/discordrb/data.rb', line 2087

def title
  @title
end

#typeSymbol (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

2097
2098
2099
# File 'lib/discordrb/data.rb', line 2097

def type
  @type
end

#urlString (readonly)

Returns the URL this embed object is based on.

Returns:

  • (String)

    the URL this embed object is based on.


2084
2085
2086
# File 'lib/discordrb/data.rb', line 2084

def url
  @url
end

#videoEmbedVideo? (readonly)

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

Returns:

  • (EmbedVideo, nil)

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


2119
2120
2121
# File 'lib/discordrb/data.rb', line 2119

def video
  @video
end