ttv::chat::ChatRoomFetchMessagesTask Class Reference

#include <chatroomfetchmessagestask.h>

Inheritance diagram for ttv::chat::ChatRoomFetchMessagesTask:

Public Types
using	Callback = std::function< void(ChatRoomFetchMessagesTask *source, TTV_ErrorCode ec, std::vector< ChatRoomMessage > &&messages, std::string &&nextCursor, bool moreMessages)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ChatRoomFetchMessagesTask (const std::string &roomId, ChannelId channelId, bool fetchNewer, uint32_t limit, const std::string &authToken, Callback &&callback)
virtual void	OnComplete () override
virtual void	SetCursor (const std::string &cursor)
virtual void	SetTime (Timestamp timestamp)
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
std::vector< ChatRoomMessage >	mResultMessages
Callback	mCallback
std::string	mRoomId
std::string	mVariableValue
std::string	mResultCursor
ChannelId	mChannelId
uint32_t	mLimit
bool	mResultMoreMessages
bool	mFetchAfter
bool	mUseTimestamp

Member Typedef Documentation

Callback

using ttv::chat::ChatRoomFetchMessagesTask::Callback = std::function<void(ChatRoomFetchMessagesTask* source, TTV_ErrorCode ec, std::vector<ChatRoomMessage>&& messages, std::string&& nextCursor, bool moreMessages)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatRoomFetchMessagesTask()

ttv::chat::ChatRoomFetchMessagesTask::ChatRoomFetchMessagesTask	(	const std::string &	roomId,
		ChannelId	channelId,
		bool	fetchNewer,
		uint32_t	limit,
		const std::string &	authToken,
		Callback &&	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

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

SetCursor()

virtual void ttv::chat::ChatRoomFetchMessagesTask::SetCursor ( const std::string &  cursor )

virtual

SetTime()

virtual void ttv::chat::ChatRoomFetchMessagesTask::SetTime ( Timestamp  timestamp )

virtual

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::chat::ChatRoomFetchMessagesTask::mCallback

private

mChannelId

ChannelId ttv::chat::ChatRoomFetchMessagesTask::mChannelId

private

mFetchAfter

bool ttv::chat::ChatRoomFetchMessagesTask::mFetchAfter

private

mLimit

uint32_t ttv::chat::ChatRoomFetchMessagesTask::mLimit

private

mResultCursor

std::string ttv::chat::ChatRoomFetchMessagesTask::mResultCursor

private

mResultMessages

std::vector<ChatRoomMessage> ttv::chat::ChatRoomFetchMessagesTask::mResultMessages

private

mResultMoreMessages

bool ttv::chat::ChatRoomFetchMessagesTask::mResultMoreMessages

private

mRoomId

std::string ttv::chat::ChatRoomFetchMessagesTask::mRoomId

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUserData

void* ttv::Task::mUserData

protectedinherited

mUseTimestamp

bool ttv::chat::ChatRoomFetchMessagesTask::mUseTimestamp

private

mVariableValue

std::string ttv::chat::ChatRoomFetchMessagesTask::mVariableValue

private

---

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

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