dpp::attachment Struct Reference

Represents an attachment in a dpp::message. More...

#include <message.h>

Collaboration diagram for dpp::attachment:

Public Member Functions
	attachment (struct message *o)
	Constructs a new attachment object. More...
	attachment (struct message *o, nlohmann::json *j)
	Constructs a new attachment object from a JSON object. More...
	~attachment ()=default
	Destructs the attachment object. More...
void	download (http_completion_event callback) const
	Download this attachment. More...

Public Attributes
std::string	content_type
std::string	description
bool	ephemeral
std::string	filename
uint32_t	height
snowflake	id
struct message *	owner
std::string	proxy_url
uint32_t	size
std::string	url
uint32_t	width

Detailed Description

Represents an attachment in a dpp::message.

Constructor & Destructor Documentation

attachment() [1/2]

dpp::attachment::attachment

(

struct message *

o

)

Constructs a new attachment object.

Parameters

o	Owning dpp::message object

attachment() [2/2]

dpp::attachment::attachment	(	struct message *	o,
		nlohmann::json *	j
	)

Constructs a new attachment object from a JSON object.

Parameters

o	Owning dpp::message object
j	JSON to read information from

~attachment()

dpp::attachment::~attachment ( )

default

Destructs the attachment object.

Member Function Documentation

download()

void dpp::attachment::download

(

http_completion_event

callback

)

const

Download this attachment.

Parameters

callback

A callback which is called when the download completes.

Note

The content of the file will be in the http_info.body parameter of the callback parameter.

Exceptions

dpp::logic_exception

If there is no owner associated with this attachment that itself has an owning cluster, this method will throw a dpp::logic_exception when called.

Member Data Documentation

content_type

std::string dpp::attachment::content_type

MIME type of the attachment, if applicable

description

std::string dpp::attachment::description

Optional: Description of the attachment (max 1024 characters)

ephemeral

bool dpp::attachment::ephemeral

Whether this attachment is ephemeral, if applicable

filename

std::string dpp::attachment::filename

File name of the attachment

height

uint32_t dpp::attachment::height

Height of the attachment, if applicable

id

snowflake dpp::attachment::id

ID of attachment

owner

struct message* dpp::attachment::owner

Owning message

proxy_url

std::string dpp::attachment::proxy_url

Proxied URL which points to the attachment

size

uint32_t dpp::attachment::size

Size of the attachment in bytes

url

std::string dpp::attachment::url

URL which points to the attachment

width

uint32_t dpp::attachment::width

Width of the attachment, if applicable