ttv::chat::ChatRoomUpdateInfoTask Class Reference

#include <chatroomupdateinfotask.h>

Inheritance diagram for ttv::chat::ChatRoomUpdateInfoTask:

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

Public Member Functions
	ChatRoomUpdateInfoTask (const std::string &roomId, const std::string &authToken, Callback &&callback)
void	SetName (const std::string &name)
void	SetTopic (const std::string &topic)
void	SetRoomRole (RoomRole role)
void	SetIsPreviewable (bool isPreviewable)
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
UpdateRoomError	mError
std::string	mRoomId
std::string	mInput
std::string	mRoomName
std::string	mRoomTopic
RoomRole	mRoomRole
bool	mRoomIsPreviewable

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatRoomUpdateInfoTask()

ttv::chat::ChatRoomUpdateInfoTask::ChatRoomUpdateInfoTask	(	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::ChatRoomUpdateInfoTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

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

SetIsPreviewable()

void ttv::chat::ChatRoomUpdateInfoTask::SetIsPreviewable

(

bool

isPreviewable

)

SetName()

void ttv::chat::ChatRoomUpdateInfoTask::SetName

(

const std::string &

name

)

SetRoomRole()

void ttv::chat::ChatRoomUpdateInfoTask::SetRoomRole

(

RoomRole

role

)

SetTopic()

void ttv::chat::ChatRoomUpdateInfoTask::SetTopic

(

const std::string &

topic

)

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::chat::ChatRoomUpdateInfoTask::mCallback

private

mError

UpdateRoomError ttv::chat::ChatRoomUpdateInfoTask::mError

private

mInput

std::string ttv::chat::ChatRoomUpdateInfoTask::mInput

private

mResult

ChatRoomInfo ttv::chat::ChatRoomUpdateInfoTask::mResult

private

mRoomId

std::string ttv::chat::ChatRoomUpdateInfoTask::mRoomId

private

mRoomIsPreviewable

bool ttv::chat::ChatRoomUpdateInfoTask::mRoomIsPreviewable

private

mRoomName

std::string ttv::chat::ChatRoomUpdateInfoTask::mRoomName

private

mRoomRole

RoomRole ttv::chat::ChatRoomUpdateInfoTask::mRoomRole

private

mRoomTopic

std::string ttv::chat::ChatRoomUpdateInfoTask::mRoomTopic

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