ttv::chat::IChatRaidListener Class Reference

#include <ichatraidlistener.h>

Inheritance diagram for ttv::chat::IChatRaidListener:

Public Member Functions
virtual	~IChatRaidListener ()=default
virtual void	RaidStarted (const RaidStatus &status)=0
virtual void	RaidUpdated (const RaidStatus &status)=0
virtual void	RaidCompleted (const RaidStatus &status)=0
virtual void	RaidCancelled (const RaidStatus &status)=0

Detailed Description

The listener interface for events from an IChatRaid implementation.

Constructor & Destructor Documentation

~IChatRaidListener()

virtual ttv::chat::IChatRaidListener::~IChatRaidListener ( )

virtualdefault

Member Function Documentation

RaidCancelled()

virtual void ttv::chat::IChatRaidListener::RaidCancelled ( const RaidStatus &  status )

pure virtual

Indicates that the raid has been cancelled and the client should NOT transition to the target channel.

Parameters

[out]

Implemented in ttv::binding::java::JavaChatRaidListenerProxy.

RaidCompleted()

virtual void ttv::chat::IChatRaidListener::RaidCompleted ( const RaidStatus &  status )

pure virtual

Indicates that the raid has been completed successfully and the client should transition to the target channel. This should fire at the same time as the timer in the UI elapses.

Parameters

[out]

Implemented in ttv::binding::java::JavaChatRaidListenerProxy.

RaidStarted()

virtual void ttv::chat::IChatRaidListener::RaidStarted ( const RaidStatus &  status )

pure virtual

Indicates that a raid has been started on the associated channel. When receiving this message the client should display a timer in the UI showing the countdown based on the remainingSecondsDuration field. Do not modify this countdown based on changes to this field in other callbacks.

Parameters

[out]

Implemented in ttv::binding::java::JavaChatRaidListenerProxy.

RaidUpdated()

virtual void ttv::chat::IChatRaidListener::RaidUpdated ( const RaidStatus &  status )

pure virtual

Indicates that there has been a change in the state of the raid. This is primarily used to update the number of users in the raid. Do not update the timer value based on the remainingSecondsDuration field, it is for informational purposes only.

Parameters

[out]

Implemented in ttv::binding::java::JavaChatRaidListenerProxy.

---

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

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