chattypes.h File Reference

#include "twitchsdk/chat/chaterrortypes.h"
#include "twitchsdk/core/types/coretypes.h"
#include "twitchsdk/core/coreutilities.h"
#include <map>
#include <regex>

Go to the source code of this file.

Classes
struct	ttv::chat::FeatureFlags
struct	ttv::chat::TokenizationOptions
struct	ttv::chat::ChatModeInfo
struct	ttv::chat::UserMode
struct	ttv::chat::SubscriptionStatus
struct	ttv::chat::ChatUserInfo
struct	ttv::chat::RestrictionReason
struct	ttv::chat::ChatChannelInfo
struct	ttv::chat::ChatChannelRestrictions
class	ttv::chat::MessageToken
struct	ttv::chat::TextToken
struct	ttv::chat::EmoticonToken
struct	ttv::chat::MentionToken
struct	ttv::chat::UrlToken
struct	ttv::chat::BitsToken
struct	ttv::chat::MessageBadge
struct	ttv::chat::MessageInfo
struct	ttv::chat::MessageInfo::Flags
struct	ttv::chat::LiveChatMessage
struct	ttv::chat::WhisperMessage
struct	ttv::chat::ChatRoomMessage
struct	ttv::chat::SubscriptionNotice
struct	ttv::chat::SubscriptionNotice::Recipient
struct	ttv::chat::FirstTimeChatterNotice
struct	ttv::chat::RaidNotice
struct	ttv::chat::UnraidNotice
struct	ttv::chat::BadgeEntitlement
struct	ttv::chat::BitsReceivedEvent
struct	ttv::chat::BitsSentEvent
struct	ttv::chat::FollowerAddedEvent
struct	ttv::chat::SubscriberAddedEvent
struct	ttv::chat::ThreadData
struct	ttv::chat::ReplayMessage
struct	ttv::chat::BadgeImage
struct	ttv::chat::BadgeVersion
struct	ttv::chat::Badge
struct	ttv::chat::BadgeSet
struct	ttv::chat::Emoticon
struct	ttv::chat::EmoticonSet
class	ttv::chat::BitsConfiguration
struct	ttv::chat::BitsConfiguration::BitsImage
struct	ttv::chat::BitsConfiguration::ImageTier
struct	ttv::chat::BitsConfiguration::Action
struct	ttv::chat::UnreadThreadCounts
struct	ttv::chat::UserList
struct	ttv::chat::ChatRoomPermissions
struct	ttv::chat::ChatRoomView
struct	ttv::chat::ChatRoomInfo
struct	ttv::chat::RoomMentionInfo
struct	ttv::chat::RaidStatus
struct	ttv::chat::HostTargetChange

Namespaces
	ttv
	JSON (JavaScript Object Notation).
	ttv::chat

Typedefs
using	ttv::chat::EmoticonId = uint32_t
using	ttv::chat::EmoticonSetId = uint32_t
using	ttv::chat::MessageId = uint32_t

Enumerations
enum	ttv::chat::ChatChannelState { ttv::chat::ChatChannelState::Disconnected, ttv::chat::ChatChannelState::Connecting, ttv::chat::ChatChannelState::Connected, ttv::chat::ChatChannelState::Disconnecting }
enum	ttv::chat::ChatMode { ttv::chat::ChatMode::Slow, ttv::chat::ChatMode::R9k, ttv::chat::ChatMode::EmotesOnly }
enum	ttv::chat::ChatReplayState { ttv::chat::ChatReplayState::Paused, ttv::chat::ChatReplayState::Playing, ttv::chat::ChatReplayState::Buffering, ttv::chat::ChatReplayState::NoMessagesForVod }
enum	ttv::chat::RoomRole { ttv::chat::RoomRole::Unknown, ttv::chat::RoomRole::Everyone, ttv::chat::RoomRole::Subscriber, ttv::chat::RoomRole::Moderator }

Functions
bool	ttv::chat::TokensEqual (const std::unique_ptr< MessageToken > &lhs, const std::unique_ptr< MessageToken > &rhs)

---

Class Documentation

ttv::chat::ChatChannelInfo

struct ttv::chat::ChatChannelInfo

ChatChannelInfo - Information about the state of a connected chat channel.

Class Members
string	broadcasterLanguage	The active broadcaster language code. Empty if there is no language filter enabled.
RestrictionReason	localUserRestriction	The active restriction for the local user.
string	name	The UTF-8 encoded name of the channel. Currently restricted to the ASCII subset.

ttv::chat::MessageBadge

struct ttv::chat::MessageBadge

MessageBadge - A badge instance associated with a message.

Class Members
string	name	Corresponds to Badge::name.
string	version	Corresponds to BadgeVersion::name.

ttv::chat::ChatRoomMessage

struct ttv::chat::ChatRoomMessage

ChatRoomMessage - A message from a single user in a chat room.

Class Members
MessageInfo	messageInfo	The information about the message.
string	roomId	The room id the message is being sent to.
string	roomMessageId	The message id for the room.

ttv::chat::FirstTimeChatterNotice

struct ttv::chat::FirstTimeChatterNotice

FirstTimeChatterNotice - A message indicating that a user has completed the first time chatter ritual.

Class Members
string	messageId	The id of the first time chatter notice.
string	systemMessage	Message generated by the system itself accompanying the user message.
MessageInfo	userMessage	Message the user provided when they completed their first chatter ritual.

ttv::chat::UnraidNotice

struct ttv::chat::UnraidNotice

UnraidNotice - A message indicating that the current channel has stopped raiding another channel.

Class Members
string	systemMessage	Message generated by the system accompanying the unraid.

ttv::chat::BitsReceivedEvent

struct ttv::chat::BitsReceivedEvent

BitsReceivedEvent - A message indicating that the given channel received a bits cheer.

Class Members
BadgeEntitlement	badge	Information about the user's new badge level, if the user reached a new badge level with this cheer.
uint32_t	bitsUsed	Number of bits used.
ChannelId	channelId	User ID of the channel on which bits were used.
string	channelName	Name of the channel on which bits were used.
string	context	Event type associated with this use of bits.
MessageInfo	message	Chat message sent with the cheer.
uint32_t	totalBitsUsed	All-time total number of bits used on this channel by the specified user.

ttv::chat::FollowerAddedEvent

struct ttv::chat::FollowerAddedEvent

FollowerAddedEvent - Info received about a new follower to a channel

Class Members
string	displayName	Display name of the person who followed the channel.
UserId	userId	User Id of the person who followed the channel.
string	userName	Username of the person who followed the channel.

ttv::chat::SubscriberAddedEvent

struct ttv::chat::SubscriberAddedEvent

SubscriberAddedEvent - Info received about a new subscriber to a channel

Class Members
ChannelId	channelId	User ID of the channel subscribed to.
string	channelName	Name of the channel subscribed to.
string	displayName	Display name of the person who subscribed to the channel.
SubscriptionNotice	subNotice	Details of the subscription.
Timestamp	timestamp	Time when subscribed event occured.
UserId	userId	User ID of the person who subscribed to the channel.
string	userName	Login name of the person who subscribed to the channel.

ttv::chat::Badge

struct ttv::chat::Badge

Badge - Information about a badge set which may have several versions.

Class Members
string	name	The unique name of the badge.
map< string, BadgeVersion >	versions	The versions available for rendering, keyed by version name.