Skip to content

EmbedFooter

Represents an embed's footer.


Properties


Text

A string that contains the footer's text.



IconUrl

An optional string that contains the url to the footer's icon.



ProxiedIconUrl

An optional string that contains a proxied url to the footer's icon.

Info

ProxiedIconUrl is only returned if the embed object was returned by Discord.



Constructors


new(text, iconUrl)

This method returns a new EmbedFooter instance.

Parameters

  • text : string - The footer's text.
  • iconUrl : string? - A url to an image.



_fromObject(embedFooterObject)

This method constructs an EmbedFooter instance from a footer object. Returns a new EmbedFooter instance.

Internal Code warning

This method is not meant to be used outside of Voyager's internal code.

Parameters



Methods


_ToObject()

This method returns a dictionary in this structure.

Internal Code warning

This method is not meant to be used outside of Voyager's internal code.



_Validate()

Validates the footer to avoid making a bad request to Discord. This method returns a tuple with 2 items a boolean and an optional string.

Internal Code warning

This method is not meant to be used outside of Voyager's internal code.

Info

The boolean value indicates whether the validation was successful, and the optional string contains the error message if validation failed.