ttv::chat::ChatGetUserThreadsTask Class Reference

#include <chatgetuserthreadstask.h>

Inheritance diagram for ttv::chat::ChatGetUserThreadsTask:

Classes
struct	Result

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

Public Member Functions
	ChatGetUserThreadsTask (const std::string &username, const std::string &authToken, const TokenizationOptions &tokenizationOptions, const std::shared_ptr< BitsConfiguration > &bitsConfiguration, Callback &&callback)
void	FetchByPage (uint32_t offset, uint32_t)
void	FetchByUser (const std::string &otherUsername)
void	FetchByThreadId (const std::string &threadId)
void	SetLocalUserNames (const std::vector< std::string > &localUserNames)
virtual void	Run ()
virtual void	Abort ()

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

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

Private Attributes
std::shared_ptr< BitsConfiguration >	mBitsConfiguration
std::shared_ptr< Result >	mResult
std::vector< std::string >	mLocalUserNames
Callback	mCallback
std::string	mUserName
std::string	mOtherUserName
std::string	mThreadId
TokenizationOptions	mTokenizationOptions
uint32_t	mOffset
uint32_t	mLimit

---

Class Documentation

ttv::chat::ChatGetUserThreadsTask::Result

struct ttv::chat::ChatGetUserThreadsTask::Result

Class Members
vector< ThreadData >	threadList
int	total
bool	valid

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatGetUserThreadsTask()

ttv::chat::ChatGetUserThreadsTask::ChatGetUserThreadsTask	(	const std::string &	username,
		const std::string &	authToken,
		const TokenizationOptions &	tokenizationOptions,
		const std::shared_ptr< BitsConfiguration > &	bitsConfiguration,
		Callback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FetchByPage()

void ttv::chat::ChatGetUserThreadsTask::FetchByPage	(	uint32_t	offset,
		uint32_t
	)

FetchByThreadId()

void ttv::chat::ChatGetUserThreadsTask::FetchByThreadId

(

const std::string &

threadId

)

FetchByUser()

void ttv::chat::ChatGetUserThreadsTask::FetchByUser

(

const std::string &

otherUsername

)

FillHttpRequestInfo()

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

protectedvirtual

Implements ttv::chat::ChatApiTask.

GetTaskName()

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

inlineprotectedvirtual

Implements ttv::Task.

OnComplete()

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

protectedvirtual

Reimplemented from ttv::chat::ChatApiTask.

ProcessHeaders()

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

protectedvirtualinherited

ProcessResponse()

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

protectedvirtual

Implements ttv::chat::ChatApiTask.

ResponseCallback()

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

protectedvirtual

Reimplemented from ttv::chat::ChatApiTask.

Run()

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

virtualinherited

Implements ttv::Task.

SetLocalUserNames()

void ttv::chat::ChatGetUserThreadsTask::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::ChatGetUserThreadsTask::mBitsConfiguration

private

mCallback

Callback ttv::chat::ChatGetUserThreadsTask::mCallback

private

mLimit

uint32_t ttv::chat::ChatGetUserThreadsTask::mLimit

private

mLocalUserNames

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

private

mOffset

uint32_t ttv::chat::ChatGetUserThreadsTask::mOffset

private

mOtherUserName

std::string ttv::chat::ChatGetUserThreadsTask::mOtherUserName

private

mResult

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

private

mTaskStatus

TTV_ErrorCode ttv::chat::ChatApiTask::mTaskStatus

protectedinherited

mThreadId

std::string ttv::chat::ChatGetUserThreadsTask::mThreadId

private

mTokenizationOptions

TokenizationOptions ttv::chat::ChatGetUserThreadsTask::mTokenizationOptions

private

mUserData

void* ttv::Task::mUserData

protectedinherited

mUserName

std::string ttv::chat::ChatGetUserThreadsTask::mUserName

private

---

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

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