ttv::chat::ChatUpdateUserThreadTask Class Reference

#include <chatupdateuserthreadtask.h>

Inheritance diagram for ttv::chat::ChatUpdateUserThreadTask:

Classes
struct	Result

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

Public Member Functions
	ChatUpdateUserThreadTask (const std::string &username, const std::string &authToken, const std::string &threadId, const TokenizationOptions &tokenizationOptions, const std::shared_ptr< BitsConfiguration > &bitsConfiguration, Callback callback)
void	SetLastRead (MessageId lastReadMessageId)
void	SetMuted (bool muted)
void	SetArchived (bool archived)
void	SetLocalUserNames (const std::vector< std::string > &localUserNames)
virtual void	Run ()
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, void *userData) override
virtual void	ProcessResponse (const std::vector< char > &response) override
virtual void	OnComplete () override
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	mThreadId
MessageId	mLastReadMessageId
TokenizationOptions	mTokenizationOptions
bool	mMuted
bool	mArchived
bool	mUpdateLastRead
bool	mUpdateMuted
bool	mUpdateArchived

---

Class Documentation

ttv::chat::ChatUpdateUserThreadTask::Result

struct ttv::chat::ChatUpdateUserThreadTask::Result

Class Members
ThreadData	threadData

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatUpdateUserThreadTask()

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

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::chat::ChatApiTask.

GetTaskName()

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

inlineoverrideprotectedvirtual

Implements ttv::Task.

OnComplete()

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

overrideprotectedvirtual

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::ChatUpdateUserThreadTask::ProcessResponse ( const std::vector< char > &  response )

overrideprotectedvirtual

Implements ttv::chat::ChatApiTask.

ResponseCallback()

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

overrideprotectedvirtual

Reimplemented from ttv::chat::ChatApiTask.

Run()

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

virtualinherited

Implements ttv::Task.

SetArchived()

void ttv::chat::ChatUpdateUserThreadTask::SetArchived

(

bool

archived

)

SetLastRead()

void ttv::chat::ChatUpdateUserThreadTask::SetLastRead

(

MessageId

lastReadMessageId

)

SetLocalUserNames()

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

inline

SetMuted()

void ttv::chat::ChatUpdateUserThreadTask::SetMuted

(

bool

muted

)

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mArchived

bool ttv::chat::ChatUpdateUserThreadTask::mArchived

private

mBitsConfiguration

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

private

mCallback

Callback ttv::chat::ChatUpdateUserThreadTask::mCallback

private

mLastReadMessageId

MessageId ttv::chat::ChatUpdateUserThreadTask::mLastReadMessageId

private

mLocalUserNames

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

private

mMuted

bool ttv::chat::ChatUpdateUserThreadTask::mMuted

private

mResult

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

private

mTaskStatus

TTV_ErrorCode ttv::chat::ChatApiTask::mTaskStatus

protectedinherited

mThreadId

std::string ttv::chat::ChatUpdateUserThreadTask::mThreadId

private

mTokenizationOptions

TokenizationOptions ttv::chat::ChatUpdateUserThreadTask::mTokenizationOptions

private

mUpdateArchived

bool ttv::chat::ChatUpdateUserThreadTask::mUpdateArchived

private

mUpdateLastRead

bool ttv::chat::ChatUpdateUserThreadTask::mUpdateLastRead

private

mUpdateMuted

bool ttv::chat::ChatUpdateUserThreadTask::mUpdateMuted

private

mUserData

void* ttv::Task::mUserData

protectedinherited

mUserName

std::string ttv::chat::ChatUpdateUserThreadTask::mUserName

private

---

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

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