ttv::chat::MentionToken Struct Reference

#include <chattypes.h>

Inheritance diagram for ttv::chat::MentionToken:

Public Types
enum	Type {   Type::Text, Type::Emoticon, Type::Mention, Type::Url,   Type::Bits }

Public Member Functions
	MentionToken (const std::string &userName, const std::string &text, bool isLocalUser)
virtual Type	GetType () const override

Public Attributes
std::string	userName
	The mentioned user. More...
std::string	text
	The original mention text used in the message. More...
bool	isLocalUser
	True if mention is for the current local user. More...

Detailed Description

MentionToken - Information about a user mention typically done via @user.

Member Enumeration Documentation

Type

enum ttv::chat::MessageToken::Type

stronginherited

Enumerator
Text
Emoticon
Mention
Url
Bits

Constructor & Destructor Documentation

MentionToken()

ttv::chat::MentionToken::MentionToken	(	const std::string &	userName,
		const std::string &	text,
		bool	isLocalUser
	)

Member Function Documentation

GetType()

virtual Type ttv::chat::MentionToken::GetType ( ) const

inlineoverridevirtual

Implements ttv::chat::MessageToken.

Member Data Documentation

isLocalUser

bool ttv::chat::MentionToken::isLocalUser

True if mention is for the current local user.

text

std::string ttv::chat::MentionToken::text

The original mention text used in the message.

userName

std::string ttv::chat::MentionToken::userName

The mentioned user.

---

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

• modules/chat/chat_common/include/twitchsdk/chat/chattypes.h