ttv::chat::ChatModUserTask Class Reference

#include <chatmodusertask.h>

Inheritance diagram for ttv::chat::ChatModUserTask:

Public Types
using	ModCallback = std::function< void(ChatModUserTask *source, TTV_ErrorCode ec, ModUserError &&error)>
using	UnmodCallback = std::function< void(ChatModUserTask *source, TTV_ErrorCode ec, UnmodUserError &&error)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatModUserTask (UserId userId, const std::string &modUserName, const std::string &authToken, ModCallback &&callback)
	ChatModUserTask (UserId userId, const std::string &modUserName, const std::string &authToken, UnmodCallback &&callback)
virtual void	OnComplete () override
virtual void	Run () override
virtual void	Abort ()

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

Static Protected Member Functions
static bool	Is2XX (uint32_t statusCode)
static bool	Is3XX (uint32_t statusCode)
static bool	Is4XX (uint32_t statusCode)

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

Private Attributes
ModCallback	mModCallback
UnmodCallback	mUnmodCallback
ModUserError	mModError
UnmodUserError	mUnmodError
std::string	mModUserName
UserId	mUserId
bool	mGrantMod

Member Typedef Documentation

ModCallback

using ttv::chat::ChatModUserTask::ModCallback = std::function<void(ChatModUserTask* source, TTV_ErrorCode ec, ModUserError&& error)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

UnmodCallback

using ttv::chat::ChatModUserTask::UnmodCallback = std::function<void(ChatModUserTask* source, TTV_ErrorCode ec, UnmodUserError&& error)>

Constructor & Destructor Documentation

ChatModUserTask() [1/2]

ttv::chat::ChatModUserTask::ChatModUserTask	(	UserId	userId,
		const std::string &	modUserName,
		const std::string &	authToken,
		ModCallback &&	callback
	)

ChatModUserTask() [2/2]

ttv::chat::ChatModUserTask::ChatModUserTask	(	UserId	userId,
		const std::string &	modUserName,
		const std::string &	authToken,
		UnmodCallback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::chat::ChatModUserTask::GetTaskName ( ) const

inlineoverrideprotectedvirtual

Implements ttv::Task.

HeadersCallback()

virtual bool ttv::HttpTask::HeadersCallback ( uint  statusCode, const std::map< std::string, std::string > &  headers  )

protectedvirtualinherited

Is2XX()

static bool ttv::HttpTask::Is2XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

Is3XX()

static bool ttv::HttpTask::Is3XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

Is4XX()

static bool ttv::HttpTask::Is4XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

OnComplete()

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

overridevirtual

Reimplemented from ttv::HttpTask.

ProcessHeaders()

virtual bool ttv::HttpTask::ProcessHeaders ( uint  statusCode, const std::map< std::string, std::string > &  headers  )

protectedvirtualinherited

Reimplemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::social::SocialUpdateFriendTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatChannelUsersTask, and ttv::social::SocialPostPresenceTask.

ProcessResponse()

virtual void ttv::chat::ChatModUserTask::ProcessResponse ( uint  statusCode, const std::vector< char > &  response  )

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

ResponseCallback()

virtual void ttv::HttpTask::ResponseCallback ( uint  statusCode, const std::vector< char > &  response  )

protectedvirtualinherited

Reimplemented in ttv::ads::FetchAdsTask, ttv::chat::ChatReplayTask, ttv::chat::ChatSendWhisperTask, and ttv::chat::ChatSetBroadcasterLanguageEnabledTask.

Run()

virtual void ttv::HttpTask::Run ( )

overridevirtualinherited

Implements ttv::Task.

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

TaskCallback ttv::Task::mCallback

protectedinherited

mGrantMod

bool ttv::chat::ChatModUserTask::mGrantMod

private

mModCallback

ModCallback ttv::chat::ChatModUserTask::mModCallback

private

mModError

ModUserError ttv::chat::ChatModUserTask::mModError

private

mModUserName

std::string ttv::chat::ChatModUserTask::mModUserName

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUnmodCallback

UnmodCallback ttv::chat::ChatModUserTask::mUnmodCallback

private

mUnmodError

UnmodUserError ttv::chat::ChatModUserTask::mUnmodError

private

mUserData

void* ttv::Task::mUserData

protectedinherited

mUserId

UserId ttv::chat::ChatModUserTask::mUserId

private

---

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

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