ttv::chat::ChatMessageHandler::ICallbacks Class Reference

#include <chatmessagehandler.h>

Inheritance diagram for ttv::chat::ChatMessageHandler::ICallbacks:

Public Member Functions
virtual	~ICallbacks ()=default
virtual bool	PassThrough (const std::string &message)=0
virtual bool	BlockUser (const std::string &blockUserName)=0
virtual bool	UnblockUser (const std::string &unblockUserName)=0
virtual bool	WhisperUser (const std::string &whisperUserName, const std::string &message)=0
virtual bool	CreateRaid (const std::string &raidTargetUserName)=0
virtual bool	CancelRaid ()=0

Detailed Description

Create your own callbacks class that inherits from this, then pass in that class to the ChatMessageHandler constructor.

Constructor & Destructor Documentation

~ICallbacks()

virtual ttv::chat::ChatMessageHandler::ICallbacks::~ICallbacks ( )

virtualdefault

Member Function Documentation

BlockUser()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::BlockUser ( const std::string &  blockUserName )

pure virtual

Called for valid /ignore and /block commands. Typically should display the necessary UI for getting a reason, then call ChatAPI::BlockUser().

Parameters

[in]

blockUserName

The name of the user to be blocked.

Returns

True if the message was handled properly, else false.

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

CancelRaid()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::CancelRaid ( )

pure virtual

Called for valid /unraid commands. Callback typically should call ChatRaid.Cancel().

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

CreateRaid()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::CreateRaid ( const std::string &  raidTargetUserName )

pure virtual

Called for valid /raid commands. Callback typically should call ChatRaid.Start().

Parameters

[in]

targetUserName

The name of the user that the raid is targetting.

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

PassThrough()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::PassThrough ( const std::string &  message )

pure virtual

The message contains normal text or an unhandled command. Callback typically should call ChatAPI::SendChatMessage().

Parameters

[in]

message

The message string being delivered through chat.

Returns

True if message was handled properly, else false.

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

UnblockUser()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::UnblockUser ( const std::string &  unblockUserName )

pure virtual

Called for valid /unignore commands. Callback typically should call ChatAPI::UnblockUser().

Parameters

[in]

unblockUserName

The name of the user to be unblocked.

Returns

True if the message was handled properly, else false.

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

WhisperUser()

virtual bool ttv::chat::ChatMessageHandler::ICallbacks::WhisperUser ( const std::string &  whisperUserName, const std::string &  message  )

pure virtual

Called for valid /w commands. Callback typically should call ChatAPI::SendMessageToUser().

Parameters

[in]	whisperUserName	The name of the user that the whisper is being sent to.
[in]	message	The message being sent to the whispered user.

Implemented in ttv::binding::java::JavaChatMessageHandlerCallbacksProxy.

---

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

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