Twitch SDK (Internal)
Public Member Functions | Protected Attributes | List of all members
ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy Class Reference

#include <java_chatroommessagehandlercallbacksproxy.h>

Inheritance diagram for ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy:
ttv::binding::java::NativeListenerProxy< ChatRoomMessageHandler::ICallbacks > ttv::chat::ChatRoomMessageHandler::ICallbacks

Public Member Functions

 JavaChatRoomMessageHandlerCallbacksProxy ()
 
virtual bool PassThrough (const std::string &message) override
 
virtual bool BanUser (const std::string &userName) override
 
virtual bool TimeoutUser (const std::string &userName, uint32_t duration) override
 
virtual bool SetUserColor (const std::string &color) override
 
virtual bool Help () override
 
virtual bool ListRooms () override
 
virtual bool ModUser (const std::string &userName) override
 
virtual bool ListModerators () override
 
virtual bool SetTopic (const std::string &topic) override
 
virtual bool UnbanUser (const std::string &userName) override
 
virtual bool UnmodUser (const std::string &userName) override
 
virtual bool UntimeoutUser (const std::string &userName) override
 
virtual bool SlowMode (bool turnOn, uint32_t durationSeconds) override
 
virtual bool R9kMode (bool turnOn) override
 
virtual bool EmotesOnlyMode (bool turnOn) override
 
virtual bool MalformedCommand (ChatRoomMessageHandler::CommandError command) override
 
void SetListener (jobject jListener)
 
jobject GetListener () const
 

Protected Attributes

GlobalJavaObjectReference mJavaListener
 
JavaClassInfo mListenerInfo
 

Constructor & Destructor Documentation

◆ JavaChatRoomMessageHandlerCallbacksProxy()

ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::JavaChatRoomMessageHandlerCallbacksProxy ( )

Member Function Documentation

◆ BanUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::BanUser ( const std::string &  userName)
overridevirtual

Called for valid /ban commands. Typically should call ChatAPI::BanUser().

Parameters
[in]userNameThe name of the user to be banned.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ EmotesOnlyMode()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::EmotesOnlyMode ( bool  turnOn)
overridevirtual

Called for valid '/emoteonly' and '/emoteonlyoff' commands. Typically should call ChatRoom::SetMode().

Parameters
[in]turnOnIf true, we want to enable emotes-only mode in the room. If false, we want to disable emote-only mode.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ GetListener()

jobject ttv::binding::java::NativeListenerProxy< ChatRoomMessageHandler::ICallbacks >::GetListener ( ) const
inlineinherited

◆ Help()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::Help ( )
overridevirtual

Called for valid /help commands. Typically should display information about the chat room commands.

Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ ListModerators()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::ListModerators ( )
overridevirtual

Called for valid /mods commands. Typically should call ChatAPI::FetchChannelModerators().

Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ ListRooms()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::ListRooms ( )
overridevirtual

Called for valid /listrooms commands. Typically should call ChannelChatRoomManager::FetchChannelChatRoomsInfo().

Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ MalformedCommand()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::MalformedCommand ( ChatRoomMessageHandler::CommandError  command)
overridevirtual

Called for invalid commands.

Parameters
[in]commandAn enum representing which command failed.
Returns
True if the error message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ ModUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::ModUser ( const std::string &  userName)
overridevirtual

Called for valid /mod commands. Typically should call ChatAPI::ModUser() after checking the sender of the message owns the current channel.

Parameters
[in]userNameThe name of the user being modded.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ PassThrough()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::PassThrough ( const std::string &  message)
overridevirtual

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

Parameters
[in]messageThe message string being delivered through chat.
Returns
True if message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ R9kMode()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::R9kMode ( bool  turnOn)
overridevirtual

Called for valid '/r9kbeta' and '/r9kbetaoff' commands. Typically should call ChatRoom::SetMode().

Parameters
[in]turnOnIf true, we want to enable r9k mode in the room. If false, we want to disable r9k mode.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ SetListener()

void ttv::binding::java::NativeListenerProxy< ChatRoomMessageHandler::ICallbacks >::SetListener ( jobject  jListener)
inlineinherited

◆ SetTopic()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::SetTopic ( const std::string &  topic)
overridevirtual

Called for valid /topic commands. Typically should call ChatRoom::SetTopic().

Parameters
[in]topicThe new topic of the room.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ SetUserColor()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::SetUserColor ( const std::string &  color)
overridevirtual

Called for valid /color commands. Typically should call ChatAPI::UpdateUserColor().

Parameters
[in]colorThe color being changed to.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ SlowMode()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::SlowMode ( bool  turnOn,
uint32_t  durationSeconds 
)
overridevirtual

Called for valid '/slow' and '/slowoff' commands. Typically should call ChatRoom::SetMode().

Parameters
[in]turnOnIf true, we want to enable slow mode in the room. If false, we want to disable slow mode.
[in]durationSecondsThe number of seconds a viewer has to wait between sending messages. Value is ignored if we're turning slow mode off.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ TimeoutUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::TimeoutUser ( const std::string &  userName,
uint32_t  duration 
)
overridevirtual

Called for valid '/timeout' commands. Typically should call ChatAPI::BanUser().

Parameters
[in]userNameThe name of the user to be timed out.
[in]durationHow long the user is timed out for in seconds.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ UnbanUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::UnbanUser ( const std::string &  userName)
overridevirtual

Called for valid /unban commands. Typically should call ChatAPI::UnbanUser().

Parameters
[in]userNameThe name of the user being unbanned.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ UnmodUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::UnmodUser ( const std::string &  userName)
overridevirtual

Called for valid /unmod commands. Typically should call ChatAPI::UnmodUser() after checking the sender of the message owns the current channel.

Parameters
[in]userNameThe name of the user being unmodded.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

◆ UntimeoutUser()

virtual bool ttv::binding::java::JavaChatRoomMessageHandlerCallbacksProxy::UntimeoutUser ( const std::string &  userName)
overridevirtual

Called for valid '/untimeout' commands. Typically should call ChatAPI::UnbanUser().

Parameters
[in]userNameThe name of the user being untimedout.
Returns
True if the message was handled properly, else false.

Implements ttv::chat::ChatRoomMessageHandler::ICallbacks.

Member Data Documentation

◆ mJavaListener

◆ mListenerInfo


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