ttv::chat::ChatApiTask Class Reference

#include <chatapitask.h>

Inheritance diagram for ttv::chat::ChatApiTask:

Classes
struct	HttpRequestInfo

Public Types
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatApiTask (TaskCallback callback, void *userData, const char *authToken)
virtual	~ChatApiTask ()
virtual void	Run ()
virtual void	OnComplete ()
virtual void	Abort ()
virtual const char *	GetTaskName () const =0

Protected Member Functions
virtual void	FillHttpRequestInfo (HttpRequestInfo &requestInfo)=0
virtual void	ResponseCallback (uint statusCode, const std::vector< char > &response, void *userData)
virtual bool	ProcessHeaders (const std::map< std::string, std::string > &headers)
virtual void	ProcessResponse (const std::vector< char > &response)=0

Protected Attributes
TTV_ErrorCode	mTaskStatus
TaskCallback	mCallback
void *	mUserData
std::atomic_bool	mAborted

Private Member Functions
bool	HeadersCallback (uint statusCode, const std::map< std::string, std::string > &headers, void *userData)

Private Attributes
std::string	mAuthToken

Member Typedef Documentation

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatApiTask()

ttv::chat::ChatApiTask::ChatApiTask ( TaskCallback  callback, void *  userData, const char *  authToken  )

inline

~ChatApiTask()

virtual ttv::chat::ChatApiTask::~ChatApiTask ( )

virtual

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::chat::ChatApiTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

protectedpure virtual

Implemented in ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, and ttv::chat::ChatUpdateUserThreadTask.

GetTaskName()

virtual const char* ttv::Task::GetTaskName ( ) const

pure virtualinherited

Implemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::ads::FetchAdsTask, ttv::broadcast::MetaDataTask, ttv::chat::ChatGetDisplayInfoTask, ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatRaidTask, ttv::chat::ChatReplayTask, ttv::social::SocialUpdateFriendTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, ttv::chat::ChatUpdateUserThreadTask, ttv::broadcast::GameStreamsTask, ttv::chat::ChatPropertiesTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatChannelUsersTask, ttv::chat::ChatSendWhisperTask, ttv::chat::ChatGetBlockListTask, ttv::chat::ChatGetBadgesTask, ttv::chat::ChatGetBitsConfigTask, ttv::chat::ChatGetEmoticonsTask, ttv::social::SocialPostPresenceTask, ttv::social::SocialPresenceSettingsTask, ttv::broadcast::ChannelInfoTask, ttv::broadcast::MatchGameNamesTask, ttv::broadcast::RecordingStatusTask, ttv::chat::ChatRoomUpdateInfoTask, ttv::chat::ChatRoomUpdateViewTask, ttv::broadcast::IngestListTask, ttv::broadcast::SetStreamInfoTask, ttv::LambdaTask, ttv::broadcast::RunCommercialTask, ttv::chat::ChatReplayDeleteTask, ttv::chat::ChatRoomFetchMessagesTask, ttv::chat::ChatSetBroadcasterLanguageEnabledTask, ttv::SimpleJsonHttpTask, ttv::chat::ChatChangeUserBlockTask, ttv::chat::ChatModUserTask, ttv::chat::ChatRoomUpdateModeTask, ttv::GetStreamTask, ttv::chat::ChatBanUserTask, ttv::GetUserTask, ttv::chat::ChatAddNewRoomTask, ttv::chat::ChatFetchChannelModeratorsTask, ttv::chat::ChatFetchChannelRoomsTask, ttv::chat::ChatRoomDeleteMessageTask, ttv::chat::ChatRoomDeleteRoomTask, ttv::chat::ChatRoomEditMessageTask, ttv::chat::ChatRoomFetchInfoTask, ttv::chat::ChatRoomJoinChannelTask, ttv::chat::ChatRoomLeaveChannelTask, ttv::chat::ChatRoomSendMessageTask, ttv::chat::ChatUnbanUserTask, ttv::chat::ChatUpdateColorTask, ttv::GetChannelTask, ttv::GetProfileImageUrlTask, ttv::ValidateOAuthTask, ttv::GetVodTask, ttv::experiment::FetchExperimentsTask, ttv::ads::ReportAdEventTask, ttv::UploadProfileImageTask, and ttv::tracking::TrackingRequestTask.

HeadersCallback()

bool ttv::chat::ChatApiTask::HeadersCallback ( uint  statusCode, const std::map< std::string, std::string > &  headers, void *  userData  )

private

OnComplete()

virtual void ttv::chat::ChatApiTask::OnComplete ( )

virtual

Implements ttv::Task.

Reimplemented in ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, and ttv::chat::ChatUpdateUserThreadTask.

ProcessHeaders()

virtual bool ttv::chat::ChatApiTask::ProcessHeaders ( const std::map< std::string, std::string > &  headers )

protectedvirtual

ProcessResponse()

virtual void ttv::chat::ChatApiTask::ProcessResponse ( const std::vector< char > &  response )

protectedpure virtual

Implemented in ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, and ttv::chat::ChatUpdateUserThreadTask.

ResponseCallback()

virtual void ttv::chat::ChatApiTask::ResponseCallback ( uint  statusCode, const std::vector< char > &  response, void *  userData  )

protectedvirtual

Reimplemented in ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, and ttv::chat::ChatUpdateUserThreadTask.

Run()

virtual void ttv::chat::ChatApiTask::Run ( )

virtual

Implements ttv::Task.

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mAuthToken

std::string ttv::chat::ChatApiTask::mAuthToken

private

mCallback

TaskCallback ttv::Task::mCallback

protectedinherited

mTaskStatus

TTV_ErrorCode ttv::chat::ChatApiTask::mTaskStatus

protected

mUserData

void* ttv::Task::mUserData

protectedinherited

---

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

• modules/chat/chat_common/include/twitchsdk/chat/internal/task/chatapitask.h