dpp::typing_start_t Struct Reference

Typing start. More...

#include <dispatcher.h>

Inheritance diagram for dpp::typing_start_t:

Collaboration diagram for dpp::typing_start_t:

Public Member Functions
	typing_start_t (class discord_client *client, const std::string &raw)
const event_dispatch_t &	cancel_event () const
	Cancels the event in progress. Any other attached lambdas for this event after this one are not called. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state). More...
bool	is_cancelled () const
	Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state). More...

Public Attributes
guild *	typing_guild
	guild user is typing on More...
channel *	typing_channel
	channel user is typing on More...
user *	typing_user
	user who is typing. Can be nullptr if user is not cached More...
snowflake	user_id
	User id of user typing. Always set regardless of caching. More...
time_t	timestamp
	Time of typing event. More...
const std::string	raw_event
	Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data. More...
class discord_client *	from
	Shard the event came from. Note that for some events, notably voice events, this may be nullptr. More...

Detailed Description

Typing start.

Constructor & Destructor Documentation

typing_start_t()

dpp::typing_start_t::typing_start_t	(	class discord_client *	client,
		const std::string &	raw
	)

Constructor

Parameters

client	The shard the event originated on
raw	Raw event text as JSON

Member Function Documentation

cancel_event()

const event_dispatch_t & dpp::event_dispatch_t::cancel_event ( ) const

inherited

Cancels the event in progress. Any other attached lambdas for this event after this one are not called. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

const event_dispatch_t& reference to self for chaining

is_cancelled()

bool dpp::event_dispatch_t::is_cancelled ( ) const

inherited

Returns true if the event is cancelled. Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).

Returns

true if the event is cancelled

Member Data Documentation

from

class discord_client* dpp::event_dispatch_t::from

inherited

Shard the event came from. Note that for some events, notably voice events, this may be nullptr.

raw_event

const std::string dpp::event_dispatch_t::raw_event

inherited

Raw event data. If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data.

timestamp

time_t dpp::typing_start_t::timestamp

Time of typing event.

typing_channel

channel* dpp::typing_start_t::typing_channel

channel user is typing on

typing_guild

guild* dpp::typing_start_t::typing_guild

guild user is typing on

typing_user

user* dpp::typing_start_t::typing_user

user who is typing. Can be nullptr if user is not cached

user_id

snowflake dpp::typing_start_t::user_id

User id of user typing. Always set regardless of caching.