ttv::chat::ChatRoomUpdateViewTask Class Reference

#include <chatroomupdateviewtask.h>

Inheritance diagram for ttv::chat::ChatRoomUpdateViewTask:

Public Types
using	Callback = std::function< void(ChatRoomUpdateViewTask *source, TTV_ErrorCode ec, ChatRoomInfo &&info)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatRoomUpdateViewTask (const std::string &roomId, const std::string &authToken, Callback &&callback)
void	SetLastReadAt (Timestamp lastReadAt)
void	SetIsMuted (bool isMuted)
void	SetIsArchived (bool isArchived)
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
void *	mUserData
std::atomic_bool	mAborted

Private Attributes
Callback	mCallback
ChatRoomInfo	mResult
std::string	mRoomId
std::string	mVariableKey
json::Value	mVariableValue

Member Typedef Documentation

Callback

using ttv::chat::ChatRoomUpdateViewTask::Callback = std::function<void(ChatRoomUpdateViewTask* source, TTV_ErrorCode ec, ChatRoomInfo&& info)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatRoomUpdateViewTask()

ttv::chat::ChatRoomUpdateViewTask::ChatRoomUpdateViewTask	(	const std::string &	roomId,
		const std::string &	authToken,
		Callback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

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

SetIsArchived()

void ttv::chat::ChatRoomUpdateViewTask::SetIsArchived

(

bool

isArchived

)

SetIsMuted()

void ttv::chat::ChatRoomUpdateViewTask::SetIsMuted

(

bool

isMuted

)

SetLastReadAt()

void ttv::chat::ChatRoomUpdateViewTask::SetLastReadAt

(

Timestamp

lastReadAt

)

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::chat::ChatRoomUpdateViewTask::mCallback

private

mResult

ChatRoomInfo ttv::chat::ChatRoomUpdateViewTask::mResult

private

mRoomId

std::string ttv::chat::ChatRoomUpdateViewTask::mRoomId

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUserData

void* ttv::Task::mUserData

protectedinherited

mVariableKey

std::string ttv::chat::ChatRoomUpdateViewTask::mVariableKey

private

mVariableValue

json::Value ttv::chat::ChatRoomUpdateViewTask::mVariableValue

private

---

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

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