dpp::embed_footer Struct Reference

A footer in a dpp::embed. More...

#include "message.h"

Collaboration diagram for dpp::embed_footer:

Public Member Functions
embed_footer &	set_icon (const std::string &i)
	Set footer's icon url. More...
embed_footer &	set_proxy (const std::string &p)
	Set footer's proxied icon url. More...
embed_footer &	set_text (const std::string &t)
	Set footer's text. More...

Public Attributes
std::string	icon_url
	Footer icon url. More...
std::string	proxy_url
	Proxied icon url. More...
std::string	text
	Footer text. More...

Detailed Description

A footer in a dpp::embed.

Member Function Documentation

set_icon()

embed_footer & dpp::embed_footer::set_icon

(

const std::string &

i

)

Set footer's icon url.

Parameters

i	url to set as footer icon url

Returns

A reference to self so this method may be "chained".

References dpp::reaction::count, dpp::reaction::count_burst, and dpp::int32_not_null().

Referenced by dpp::embed::set_timestamp().

Here is the call graph for this function:

Here is the caller graph for this function:

set_proxy()

embed_footer & dpp::embed_footer::set_proxy

(

const std::string &

p

)

Set footer's proxied icon url.

Parameters

p	url to set as footer proxied icon url

Returns

A reference to self so this method may be "chained".

set_text()

embed_footer & dpp::embed_footer::set_text

(

const std::string &

t

)

Set footer's text.

Parameters

t	string to set as footer text. It will be truncated to the maximum length of 2048 UTF-8 characters.

Returns

A reference to self so this method may be "chained".

Referenced by dpp::embed::set_timestamp().

Here is the caller graph for this function:

Member Data Documentation

icon_url

std::string dpp::embed_footer::icon_url

Footer icon url.

Warning

Only supports http(s) and attachments.

Referenced by dpp::embed::set_color().

proxy_url

std::string dpp::embed_footer::proxy_url

Proxied icon url.

Referenced by dpp::embed::set_colour().

text

std::string dpp::embed_footer::text

Footer text.

Referenced by dpp::embed::set_description().

---

The documentation for this struct was generated from the following files:

• message.h
• message.cpp