MessageEmbedBuilder¶

Inherits: Reference < Object

Description¶

Helper class to build message embeds.

Methods¶

return type	signature
MessageEmbedBuilder	set_title ( String title )
MessageEmbedBuilder	set_description ( String description )
MessageEmbedBuilder	set_url ( String url )
MessageEmbedBuilder	set_timestamp ( int unix_timestamp )
MessageEmbedBuilder	set_color ( Color color )
MessageEmbedBuilder	set_footer ( MessageEmbedFooterBuilder footer )
MessageEmbedBuilder	set_image ( MessageEmbedAttachmentBuilder image )
MessageEmbedBuilder	set_thumbnail ( MessageEmbedAttachmentBuilder thumbnail )
MessageEmbedBuilder	set_video ( MessageEmbedAttachmentBuilder video )
MessageEmbedBuilder	set_provider ( MessageEmbedProviderBuilder provider )
MessageEmbedBuilder	set_author ( MessageEmbedAuthorBuilder author )
MessageEmbedBuilder	add_field ( String name, String value, bool inline=false )
Dictionary	build ( )

Constants¶

• int MAX_FIELDS = 25

  There is currently no description for this constant.

Method Descriptions¶

• MessageEmbedBuilder set_title ( String title )

  Sets the embed's title.

  ---

• MessageEmbedBuilder set_description ( String description )

  Sets the embed's description.

  ---

• MessageEmbedBuilder set_url ( String url )

  Sets the embed's url.

  ---

• MessageEmbedBuilder set_timestamp ( int unix_timestamp )

  Sets the embed's timestamp. unix_timestamp takes a Unix time in seconds.

  ---

• MessageEmbedBuilder set_color ( Color color )

  Sets the embed's color.

  ---

• MessageEmbedBuilder set_footer ( MessageEmbedFooterBuilder footer )

  Sets the embed's footer information.

  ---

• MessageEmbedBuilder set_image ( MessageEmbedAttachmentBuilder image )

  Sets the embed's image.

  ---

• MessageEmbedBuilder set_thumbnail ( MessageEmbedAttachmentBuilder thumbnail )

  Sets the embed's thumbnail.

  ---

• MessageEmbedBuilder set_video ( MessageEmbedAttachmentBuilder video )

  Sets the embed's video.

  ---

• MessageEmbedBuilder set_provider ( MessageEmbedProviderBuilder provider )

  Sets the embed's provider information.

  ---

• MessageEmbedBuilder set_author ( MessageEmbedAuthorBuilder author )

  Sets the embed's author information.

  ---

• MessageEmbedBuilder add_field ( String name, String value, bool inline=false )

  Adds a field to the embed. if inline is true, the field will displayed on the same line next to the previous field. You can add up to 25 fields.

  ---

• Dictionary build ( )

  Returns the embed data as a Dictionary.

  ---