ttv::chat::IChatRoomNotificationsListener Class Reference

#include <ichatroomnotificationslistener.h>

Inheritance diagram for ttv::chat::IChatRoomNotificationsListener:

Public Member Functions
virtual void	UserTimedOut (UserId userId, ChannelId channelId, Timestamp expiresAt)=0
virtual void	UserBanned (UserId userId, ChannelId channelId)=0
virtual void	UserUnbanned (UserId userId, ChannelId channelId)=0
virtual void	RoomViewUpdated (UserId userId, ChannelId roomOwnerId, const std::string &roomId, ChatRoomView &&roomViewInfo)=0
virtual void	RoomMentionReceived (UserId userId, RoomMentionInfo &&mentionInfo)=0

Detailed Description

Listener interface for unsolicited events for chat rooms on a user level.

Member Function Documentation

RoomMentionReceived()

virtual void ttv::chat::IChatRoomNotificationsListener::RoomMentionReceived ( UserId  userId, RoomMentionInfo &&  mentionInfo  )

pure virtual

Called when the user is mentioned in a chat room.

Parameters

[in]	userId	The id of the user who is being mentioned.
[in]	mentionInfo	Information about the mention message.

Implemented in ttv::binding::java::JavaIChatRoomNotificationsListenerProxy.

RoomViewUpdated()

virtual void ttv::chat::IChatRoomNotificationsListener::RoomViewUpdated ( UserId  userId, ChannelId  roomOwnerId, const std::string &  roomId, ChatRoomView &&  roomViewInfo  )

pure virtual

Called when the user's view of the chat room is changed.

Parameters

[in]	userId	The id of the user whose room view has been updated.
[in]	roomOwnerId	The id of the channel that owns the room.
[in]	roomId	The id of the room that has an updated view.
[in]	roomViewInfo	The new view information for the user and room.

Implemented in ttv::binding::java::JavaIChatRoomNotificationsListenerProxy.

UserBanned()

virtual void ttv::chat::IChatRoomNotificationsListener::UserBanned ( UserId  userId, ChannelId  channelId  )

pure virtual

Called when the user is banned from a channel.

Parameters

[in]	userId	The id of the user that was banned.
[in]	channelId	The channel that the user was banned from.

Implemented in ttv::binding::java::JavaIChatRoomNotificationsListenerProxy.

UserTimedOut()

virtual void ttv::chat::IChatRoomNotificationsListener::UserTimedOut ( UserId  userId, ChannelId  channelId, Timestamp  expiresAt  )

pure virtual

Called when the user is timed out from a channel.

Parameters

[in]	userId	The id of the user that was timed out.
[in]	channelId	The channel that the user was timed out of.
[in]	expiresAt	The timestamp when the timeout is over.

Implemented in ttv::binding::java::JavaIChatRoomNotificationsListenerProxy.

UserUnbanned()

virtual void ttv::chat::IChatRoomNotificationsListener::UserUnbanned ( UserId  userId, ChannelId  channelId  )

pure virtual

Called when the user is unbanned from a channel.

Parameters

[in]	userId	The id of the user that was unbanned
[in]	channelId	The channel that the user was unbanned from.

Implemented in ttv::binding::java::JavaIChatRoomNotificationsListenerProxy.

---

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

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