ttv::chat::ChatRaidTask Class Reference

#include <chatraidtask.h>

Inheritance diagram for ttv::chat::ChatRaidTask:

Public Types
enum	ChangeType {   ChangeType::Join, ChangeType::Leave, ChangeType::Start, ChangeType::Cancel,   ChangeType::Invalid }
using	Callback = std::function< void(ChatRaidTask *source, TTV_ErrorCode result)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatRaidTask (UserId sourceUserId, const std::string &authToken, Callback &&callback)
void	Join (const std::string &raidId)
void	Leave (const std::string &raidId)
void	Start (UserId targetUserId)
void	Cancel (UserId targetUserId)
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 void	OnComplete () 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
void *	mUserData
std::atomic_bool	mAborted

Private Attributes
Callback	mCallback
std::string	mRaidId
UserId	mSourceUserId
UserId	mTargetUserId
RaidStatus	mResult
ChangeType	mChangeType

Member Typedef Documentation

Callback

using ttv::chat::ChatRaidTask::Callback = std::function<void(ChatRaidTask* source, TTV_ErrorCode result)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Member Enumeration Documentation

ChangeType

enum ttv::chat::ChatRaidTask::ChangeType

strong

Enumerator
Join
Leave
Start
Cancel
Invalid

Constructor & Destructor Documentation

ChatRaidTask()

ttv::chat::ChatRaidTask::ChatRaidTask	(	UserId	sourceUserId,
		const std::string &	authToken,
		Callback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

Cancel()

void ttv::chat::ChatRaidTask::Cancel

(

UserId

targetUserId

)

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::chat::ChatRaidTask::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

Join()

void ttv::chat::ChatRaidTask::Join

(

const std::string &

raidId

)

Leave()

void ttv::chat::ChatRaidTask::Leave

(

const std::string &

raidId

)

OnComplete()

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

overrideprotectedvirtual

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::ChatRaidTask::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.

Start()

void ttv::chat::ChatRaidTask::Start

(

UserId

targetUserId

)

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::chat::ChatRaidTask::mCallback

private

mChangeType

ChangeType ttv::chat::ChatRaidTask::mChangeType

private

mRaidId

std::string ttv::chat::ChatRaidTask::mRaidId

private

mResult

RaidStatus ttv::chat::ChatRaidTask::mResult

private

mSourceUserId

UserId ttv::chat::ChatRaidTask::mSourceUserId

private

mTargetUserId

UserId ttv::chat::ChatRaidTask::mTargetUserId

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

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/chatraidtask.h