Skip to content

EmbedAuthor

Represents an embed's author.


Properties



Name

A string that contains the author's name.




Url

An optional string that contains the author's url.




IconUrl

An optional string that contains the authors's icon url.




ProxiedIconUrl

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

Info

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




Constructors



new(name, url, iconUrl)

This method returns a new EmbedAuthor instance.

Parameters




_fromObject(embedAuthorObject)

This method constructs an EmbedAuthor instance from an author object. Returns a new EmbedAuthor 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 author to avoid making a bad request to Discord. This method returns a tuple containing 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.