ttv::chat::ChatReplayTask Class Reference

#include <chatreplaytask.h>

Inheritance diagram for ttv::chat::ChatReplayTask:

Classes
struct	Result

Public Types
typedef std::function< void(ChatReplayTask *source, TTV_ErrorCode ec, std::shared_ptr< Result > result)>	Callback
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatReplayTask (const std::string &vodId, Timestamp time, const TokenizationOptions &options, const std::shared_ptr< BitsConfiguration > &mBitsConfiguration, Callback &&callback)
void	SetFetchLimit (uint32_t limit)
void	SetCursorUrl (std::string url)
void	SetLocalUserNames (const std::vector< std::string > &localUserNames)
virtual void	Run () override
virtual void	Abort ()

Protected Member Functions
virtual const char *	GetTaskName () const override
virtual void	FillHttpRequestInfo (HttpRequestInfo &requestInfo) override
virtual void	ResponseCallback (uint statusCode, const std::vector< char > &response) 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 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
std::string	mCursorUrl
std::string	mVodId
Timestamp	mTimestamp
uint32_t	mLimit
std::shared_ptr< BitsConfiguration >	mBitsConfiguration
std::vector< std::string >	mLocalUserNames
std::shared_ptr< Result >	mResult
TokenizationOptions	mTokenizationOptions
Callback	mCallback

---

Class Documentation

ttv::chat::ChatReplayTask::Result

struct ttv::chat::ChatReplayTask::Result

Class Members
bool	hasNoMessages
vector< MessageBatch >	messageListBatches
string	nextUrl

Member Typedef Documentation

Callback

typedef std::function<void(ChatReplayTask* source, TTV_ErrorCode ec, std::shared_ptr<Result> result)> ttv::chat::ChatReplayTask::Callback

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatReplayTask()

ttv::chat::ChatReplayTask::ChatReplayTask	(	const std::string &	vodId,
		Timestamp	time,
		const TokenizationOptions &	options,
		const std::shared_ptr< BitsConfiguration > &	mBitsConfiguration,
		Callback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::chat::ChatReplayTask::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::ChatReplayTask::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::ChatReplayTask::ProcessResponse ( uint  statusCode, const std::vector< char > &  response  )

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

ResponseCallback()

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

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

Run()

virtual void ttv::HttpTask::Run ( )

overridevirtualinherited

Implements ttv::Task.

SetCursorUrl()

void ttv::chat::ChatReplayTask::SetCursorUrl

(

std::string

url

)

SetFetchLimit()

void ttv::chat::ChatReplayTask::SetFetchLimit

(

uint32_t

limit

)

SetLocalUserNames()

void ttv::chat::ChatReplayTask::SetLocalUserNames ( const std::vector< std::string > &  localUserNames )

inline

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mBitsConfiguration

std::shared_ptr<BitsConfiguration> ttv::chat::ChatReplayTask::mBitsConfiguration

private

mCallback

Callback ttv::chat::ChatReplayTask::mCallback

private

mCursorUrl

std::string ttv::chat::ChatReplayTask::mCursorUrl

private

mLimit

uint32_t ttv::chat::ChatReplayTask::mLimit

private

mLocalUserNames

std::vector<std::string> ttv::chat::ChatReplayTask::mLocalUserNames

private

mResult

std::shared_ptr<Result> ttv::chat::ChatReplayTask::mResult

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mTimestamp

Timestamp ttv::chat::ChatReplayTask::mTimestamp

private

mTokenizationOptions

TokenizationOptions ttv::chat::ChatReplayTask::mTokenizationOptions

private

mUserData

void* ttv::Task::mUserData

protectedinherited

mVodId

std::string ttv::chat::ChatReplayTask::mVodId

private

---

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

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