Chatterino
Public Types | Public Member Functions | Protected Member Functions | List of all members
chatterino::IHelix Class Referenceabstract

#include <Helix.hpp>

Inheritance diagram for chatterino::IHelix:
[legend]

Public Types

template<typename... T>
using FailureCallback = std::function< void(T...)>
 

Public Member Functions

virtual void fetchUsers (QStringList userIds, QStringList userLogins, ResultCallback< std::vector< HelixUser >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getUserByName (QString userName, ResultCallback< HelixUser > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getUserById (QString userId, ResultCallback< HelixUser > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void fetchUsersFollows (QString fromId, QString toId, ResultCallback< HelixUsersFollowsResponse > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getUserFollowers (QString userId, ResultCallback< HelixUsersFollowsResponse > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void fetchStreams (QStringList userIds, QStringList userLogins, ResultCallback< std::vector< HelixStream >> successCallback, HelixFailureCallback failureCallback, std::function< void()> finallyCallback)=0
 
virtual void getStreamById (QString userId, ResultCallback< bool, HelixStream > successCallback, HelixFailureCallback failureCallback, std::function< void()> finallyCallback)=0
 
virtual void getStreamByName (QString userName, ResultCallback< bool, HelixStream > successCallback, HelixFailureCallback failureCallback, std::function< void()> finallyCallback)=0
 
virtual void fetchGames (QStringList gameIds, QStringList gameNames, ResultCallback< std::vector< HelixGame >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void searchGames (QString gameName, ResultCallback< std::vector< HelixGame >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getGameById (QString gameId, ResultCallback< HelixGame > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void createClip (QString channelId, ResultCallback< HelixClip > successCallback, std::function< void(HelixClipError)> failureCallback, std::function< void()> finallyCallback)=0
 
virtual void getChannel (QString broadcasterId, ResultCallback< HelixChannel > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void createStreamMarker (QString broadcasterId, QString description, ResultCallback< HelixStreamMarker > successCallback, std::function< void(HelixStreamMarkerError)> failureCallback)=0
 
virtual void loadBlocks (QString userId, ResultCallback< std::vector< HelixBlock >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void blockUser (QString targetUserId, std::function< void()> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void unblockUser (QString targetUserId, std::function< void()> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void updateChannel (QString broadcasterId, QString gameId, QString language, QString title, std::function< void(NetworkResult)> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void manageAutoModMessages (QString userID, QString msgID, QString action, std::function< void()> successCallback, std::function< void(HelixAutoModMessageError)> failureCallback)=0
 
virtual void getCheermotes (QString broadcasterId, ResultCallback< std::vector< HelixCheermoteSet >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getEmoteSetData (QString emoteSetId, ResultCallback< HelixEmoteSetData > successCallback, HelixFailureCallback failureCallback)=0
 
virtual void getChannelEmotes (QString broadcasterId, ResultCallback< std::vector< HelixChannelEmote >> successCallback, HelixFailureCallback failureCallback)=0
 
virtual void updateUserChatColor (QString userID, QString color, ResultCallback<> successCallback, FailureCallback< HelixUpdateUserChatColorError, QString > failureCallback)=0
 
virtual void deleteChatMessages (QString broadcasterID, QString moderatorID, QString messageID, ResultCallback<> successCallback, FailureCallback< HelixDeleteChatMessagesError, QString > failureCallback)=0
 
virtual void addChannelModerator (QString broadcasterID, QString userID, ResultCallback<> successCallback, FailureCallback< HelixAddChannelModeratorError, QString > failureCallback)=0
 
virtual void removeChannelModerator (QString broadcasterID, QString userID, ResultCallback<> successCallback, FailureCallback< HelixRemoveChannelModeratorError, QString > failureCallback)=0
 
virtual void sendChatAnnouncement (QString broadcasterID, QString moderatorID, QString message, HelixAnnouncementColor color, ResultCallback<> successCallback, FailureCallback< HelixSendChatAnnouncementError, QString > failureCallback)=0
 
virtual void addChannelVIP (QString broadcasterID, QString userID, ResultCallback<> successCallback, FailureCallback< HelixAddChannelVIPError, QString > failureCallback)=0
 
virtual void removeChannelVIP (QString broadcasterID, QString userID, ResultCallback<> successCallback, FailureCallback< HelixRemoveChannelVIPError, QString > failureCallback)=0
 
virtual void unbanUser (QString broadcasterID, QString moderatorID, QString userID, ResultCallback<> successCallback, FailureCallback< HelixUnbanUserError, QString > failureCallback)=0
 
virtual void startRaid (QString fromBroadcasterID, QString toBroadcasterID, ResultCallback<> successCallback, FailureCallback< HelixStartRaidError, QString > failureCallback)=0
 
virtual void cancelRaid (QString broadcasterID, ResultCallback<> successCallback, FailureCallback< HelixCancelRaidError, QString > failureCallback)=0
 
virtual void updateEmoteMode (QString broadcasterID, QString moderatorID, bool emoteMode, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void updateFollowerMode (QString broadcasterID, QString moderatorID, boost::optional< int > followerModeDuration, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void updateNonModeratorChatDelay (QString broadcasterID, QString moderatorID, boost::optional< int > nonModeratorChatDelayDuration, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void updateSlowMode (QString broadcasterID, QString moderatorID, boost::optional< int > slowModeWaitTime, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void updateSubscriberMode (QString broadcasterID, QString moderatorID, bool subscriberMode, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void updateUniqueChatMode (QString broadcasterID, QString moderatorID, bool uniqueChatMode, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 
virtual void banUser (QString broadcasterID, QString moderatorID, QString userID, boost::optional< int > duration, QString reason, ResultCallback<> successCallback, FailureCallback< HelixBanUserError, QString > failureCallback)=0
 
virtual void sendWhisper (QString fromUserID, QString toUserID, QString message, ResultCallback<> successCallback, FailureCallback< HelixWhisperError, QString > failureCallback)=0
 
virtual void getChatters (QString broadcasterID, QString moderatorID, int maxChattersToFetch, ResultCallback< HelixChatters > successCallback, FailureCallback< HelixGetChattersError, QString > failureCallback)=0
 
virtual void getModerators (QString broadcasterID, int maxModeratorsToFetch, ResultCallback< std::vector< HelixModerator >> successCallback, FailureCallback< HelixGetModeratorsError, QString > failureCallback)=0
 
virtual void getChannelVIPs (QString broadcasterID, ResultCallback< std::vector< HelixVip >> successCallback, FailureCallback< HelixListVIPsError, QString > failureCallback)=0
 
virtual void startCommercial (QString broadcasterID, int length, ResultCallback< HelixStartCommercialResponse > successCallback, FailureCallback< HelixStartCommercialError, QString > failureCallback)=0
 
virtual void update (QString clientId, QString oauthToken)=0
 

Protected Member Functions

virtual void updateChatSettings (QString broadcasterID, QString moderatorID, QJsonObject json, ResultCallback< HelixChatSettings > successCallback, FailureCallback< HelixUpdateChatSettingsError, QString > failureCallback)=0
 

Member Typedef Documentation

◆ FailureCallback

template<typename... T>
using chatterino::IHelix::FailureCallback = std::function<void(T...)>

Member Function Documentation

◆ addChannelModerator()

virtual void chatterino::IHelix::addChannelModerator ( QString  broadcasterID,
QString  userID,
ResultCallback<>  successCallback,
FailureCallback< HelixAddChannelModeratorError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ addChannelVIP()

virtual void chatterino::IHelix::addChannelVIP ( QString  broadcasterID,
QString  userID,
ResultCallback<>  successCallback,
FailureCallback< HelixAddChannelVIPError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ banUser()

virtual void chatterino::IHelix::banUser ( QString  broadcasterID,
QString  moderatorID,
QString  userID,
boost::optional< int >  duration,
QString  reason,
ResultCallback<>  successCallback,
FailureCallback< HelixBanUserError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ blockUser()

virtual void chatterino::IHelix::blockUser ( QString  targetUserId,
std::function< void()>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ cancelRaid()

virtual void chatterino::IHelix::cancelRaid ( QString  broadcasterID,
ResultCallback<>  successCallback,
FailureCallback< HelixCancelRaidError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ createClip()

virtual void chatterino::IHelix::createClip ( QString  channelId,
ResultCallback< HelixClip successCallback,
std::function< void(HelixClipError)>  failureCallback,
std::function< void()>  finallyCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ createStreamMarker()

virtual void chatterino::IHelix::createStreamMarker ( QString  broadcasterId,
QString  description,
ResultCallback< HelixStreamMarker successCallback,
std::function< void(HelixStreamMarkerError)>  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ deleteChatMessages()

virtual void chatterino::IHelix::deleteChatMessages ( QString  broadcasterID,
QString  moderatorID,
QString  messageID,
ResultCallback<>  successCallback,
FailureCallback< HelixDeleteChatMessagesError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ fetchGames()

virtual void chatterino::IHelix::fetchGames ( QStringList  gameIds,
QStringList  gameNames,
ResultCallback< std::vector< HelixGame >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ fetchStreams()

virtual void chatterino::IHelix::fetchStreams ( QStringList  userIds,
QStringList  userLogins,
ResultCallback< std::vector< HelixStream >>  successCallback,
HelixFailureCallback  failureCallback,
std::function< void()>  finallyCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ fetchUsers()

virtual void chatterino::IHelix::fetchUsers ( QStringList  userIds,
QStringList  userLogins,
ResultCallback< std::vector< HelixUser >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ fetchUsersFollows()

virtual void chatterino::IHelix::fetchUsersFollows ( QString  fromId,
QString  toId,
ResultCallback< HelixUsersFollowsResponse successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getChannel()

virtual void chatterino::IHelix::getChannel ( QString  broadcasterId,
ResultCallback< HelixChannel successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getChannelEmotes()

virtual void chatterino::IHelix::getChannelEmotes ( QString  broadcasterId,
ResultCallback< std::vector< HelixChannelEmote >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getChannelVIPs()

virtual void chatterino::IHelix::getChannelVIPs ( QString  broadcasterID,
ResultCallback< std::vector< HelixVip >>  successCallback,
FailureCallback< HelixListVIPsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getChatters()

virtual void chatterino::IHelix::getChatters ( QString  broadcasterID,
QString  moderatorID,
int  maxChattersToFetch,
ResultCallback< HelixChatters successCallback,
FailureCallback< HelixGetChattersError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getCheermotes()

virtual void chatterino::IHelix::getCheermotes ( QString  broadcasterId,
ResultCallback< std::vector< HelixCheermoteSet >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getEmoteSetData()

virtual void chatterino::IHelix::getEmoteSetData ( QString  emoteSetId,
ResultCallback< HelixEmoteSetData successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getGameById()

virtual void chatterino::IHelix::getGameById ( QString  gameId,
ResultCallback< HelixGame successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getModerators()

virtual void chatterino::IHelix::getModerators ( QString  broadcasterID,
int  maxModeratorsToFetch,
ResultCallback< std::vector< HelixModerator >>  successCallback,
FailureCallback< HelixGetModeratorsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getStreamById()

virtual void chatterino::IHelix::getStreamById ( QString  userId,
ResultCallback< bool, HelixStream successCallback,
HelixFailureCallback  failureCallback,
std::function< void()>  finallyCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getStreamByName()

virtual void chatterino::IHelix::getStreamByName ( QString  userName,
ResultCallback< bool, HelixStream successCallback,
HelixFailureCallback  failureCallback,
std::function< void()>  finallyCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ getUserById()

virtual void chatterino::IHelix::getUserById ( QString  userId,
ResultCallback< HelixUser successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getUserByName()

virtual void chatterino::IHelix::getUserByName ( QString  userName,
ResultCallback< HelixUser successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ getUserFollowers()

virtual void chatterino::IHelix::getUserFollowers ( QString  userId,
ResultCallback< HelixUsersFollowsResponse successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ loadBlocks()

virtual void chatterino::IHelix::loadBlocks ( QString  userId,
ResultCallback< std::vector< HelixBlock >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ manageAutoModMessages()

virtual void chatterino::IHelix::manageAutoModMessages ( QString  userID,
QString  msgID,
QString  action,
std::function< void()>  successCallback,
std::function< void(HelixAutoModMessageError)>  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ removeChannelModerator()

virtual void chatterino::IHelix::removeChannelModerator ( QString  broadcasterID,
QString  userID,
ResultCallback<>  successCallback,
FailureCallback< HelixRemoveChannelModeratorError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ removeChannelVIP()

virtual void chatterino::IHelix::removeChannelVIP ( QString  broadcasterID,
QString  userID,
ResultCallback<>  successCallback,
FailureCallback< HelixRemoveChannelVIPError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ searchGames()

virtual void chatterino::IHelix::searchGames ( QString  gameName,
ResultCallback< std::vector< HelixGame >>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ sendChatAnnouncement()

virtual void chatterino::IHelix::sendChatAnnouncement ( QString  broadcasterID,
QString  moderatorID,
QString  message,
HelixAnnouncementColor  color,
ResultCallback<>  successCallback,
FailureCallback< HelixSendChatAnnouncementError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ sendWhisper()

virtual void chatterino::IHelix::sendWhisper ( QString  fromUserID,
QString  toUserID,
QString  message,
ResultCallback<>  successCallback,
FailureCallback< HelixWhisperError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ startCommercial()

virtual void chatterino::IHelix::startCommercial ( QString  broadcasterID,
int  length,
ResultCallback< HelixStartCommercialResponse successCallback,
FailureCallback< HelixStartCommercialError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ startRaid()

virtual void chatterino::IHelix::startRaid ( QString  fromBroadcasterID,
QString  toBroadcasterID,
ResultCallback<>  successCallback,
FailureCallback< HelixStartRaidError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ unbanUser()

virtual void chatterino::IHelix::unbanUser ( QString  broadcasterID,
QString  moderatorID,
QString  userID,
ResultCallback<>  successCallback,
FailureCallback< HelixUnbanUserError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ unblockUser()

virtual void chatterino::IHelix::unblockUser ( QString  targetUserId,
std::function< void()>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ update()

virtual void chatterino::IHelix::update ( QString  clientId,
QString  oauthToken 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateChannel()

virtual void chatterino::IHelix::updateChannel ( QString  broadcasterId,
QString  gameId,
QString  language,
QString  title,
std::function< void(NetworkResult)>  successCallback,
HelixFailureCallback  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ updateChatSettings()

virtual void chatterino::IHelix::updateChatSettings ( QString  broadcasterID,
QString  moderatorID,
QJsonObject  json,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
protectedpure virtual

Implemented in chatterino::Helix.

◆ updateEmoteMode()

virtual void chatterino::IHelix::updateEmoteMode ( QString  broadcasterID,
QString  moderatorID,
bool  emoteMode,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateFollowerMode()

virtual void chatterino::IHelix::updateFollowerMode ( QString  broadcasterID,
QString  moderatorID,
boost::optional< int >  followerModeDuration,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateNonModeratorChatDelay()

virtual void chatterino::IHelix::updateNonModeratorChatDelay ( QString  broadcasterID,
QString  moderatorID,
boost::optional< int >  nonModeratorChatDelayDuration,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

◆ updateSlowMode()

virtual void chatterino::IHelix::updateSlowMode ( QString  broadcasterID,
QString  moderatorID,
boost::optional< int >  slowModeWaitTime,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateSubscriberMode()

virtual void chatterino::IHelix::updateSubscriberMode ( QString  broadcasterID,
QString  moderatorID,
bool  subscriberMode,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateUniqueChatMode()

virtual void chatterino::IHelix::updateUniqueChatMode ( QString  broadcasterID,
QString  moderatorID,
bool  uniqueChatMode,
ResultCallback< HelixChatSettings successCallback,
FailureCallback< HelixUpdateChatSettingsError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.

Here is the caller graph for this function:

◆ updateUserChatColor()

virtual void chatterino::IHelix::updateUserChatColor ( QString  userID,
QString  color,
ResultCallback<>  successCallback,
FailureCallback< HelixUpdateUserChatColorError, QString >  failureCallback 
)
pure virtual

Implemented in chatterino::Helix.


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