Twitch SDK (Internal)
Public Types | Public Member Functions | List of all members
ttv::chat::IChatChannel Class Referenceabstract

#include <ichatchannel.h>

Inheritance diagram for ttv::chat::IChatChannel:
ttv::chat::ChatChannelWrapper

Public Types

using SetBroadcasterLanguageChatEnabledCallback = std::function< void(TTV_ErrorCode ec)>
 

Public Member Functions

virtual ~IChatChannel ()
 
virtual TTV_ErrorCode Dispose ()=0
 
virtual TTV_ErrorCode Connect ()=0
 
virtual TTV_ErrorCode Disconnect ()=0
 
virtual TTV_ErrorCode SendMessage (const std::string &message)=0
 
virtual TTV_ErrorCode SetBroadcasterLanguageChatEnabled (bool enabled, const SetBroadcasterLanguageChatEnabledCallback &callback)=0
 
virtual TTV_ErrorCode OptInToBroadcasterLanguageChat (const std::string &language)=0
 

Detailed Description

The interface for connecting to a live chat channel.

Member Typedef Documentation

◆ SetBroadcasterLanguageChatEnabledCallback

Constructor & Destructor Documentation

◆ ~IChatChannel()

virtual ttv::chat::IChatChannel::~IChatChannel ( )
virtual

Member Function Documentation

◆ Connect()

virtual TTV_ErrorCode ttv::chat::IChatChannel::Connect ( )
pure virtual

◆ Disconnect()

virtual TTV_ErrorCode ttv::chat::IChatChannel::Disconnect ( )
pure virtual

◆ Dispose()

virtual TTV_ErrorCode ttv::chat::IChatChannel::Dispose ( )
pure virtual

This should be called when the application is done with the instance.

Implemented in ttv::chat::ChatChannelWrapper.

◆ OptInToBroadcasterLanguageChat()

virtual TTV_ErrorCode ttv::chat::IChatChannel::OptInToBroadcasterLanguageChat ( const std::string &  language)
pure virtual

◆ SendMessage()

virtual TTV_ErrorCode ttv::chat::IChatChannel::SendMessage ( const std::string &  message)
pure virtual

◆ SetBroadcasterLanguageChatEnabled()

virtual TTV_ErrorCode ttv::chat::IChatChannel::SetBroadcasterLanguageChatEnabled ( bool  enabled,
const SetBroadcasterLanguageChatEnabledCallback callback 
)
pure virtual

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