ttv::social::SocialFriendRequestsTask Class Reference

#include <socialfriendrequeststask.h>

Inheritance diagram for ttv::social::SocialFriendRequestsTask:

Classes
struct	FriendRequestEntry
struct	Result

Public Types
enum	Action { Action::Unset, Action::Fetch, Action::MarkAllRead, Action::GetUnreadCount }
enum	SortDirection { SortDirection::Descending, SortDirection::Ascending }
typedef std::function< void(SocialFriendRequestsTask *source, TTV_ErrorCode ec, std::shared_ptr< Result > result)>	Callback
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	SocialFriendRequestsTask (UserId userId, const std::string &authToken, Callback callback)
void	FetchRequests (uint32_t limit, SortDirection sortDirection, const std::string &cursor)
void	MarkAllRead ()
void	GetUnreadCount ()
virtual void	Run () override
virtual void	Abort ()

Static Public Attributes
static const uint32_t	kMaxLimit = 500

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

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 Member Functions
bool	ParseFriendRequestListJson (const json::Value &jArray)

Private Attributes
std::shared_ptr< Result >	mResult
Callback	mCallback
std::string	mCursor
Action	mAction
SortDirection	mSortDirection
UserId	mUserId
uint32_t	mLimit

---

Class Documentation

ttv::social::SocialFriendRequestsTask::FriendRequestEntry

struct ttv::social::SocialFriendRequestsTask::FriendRequestEntry

Class Members
Timestamp	requestedTimestamp	The time that the request was sent.
UserInfo	userInfo

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Member Enumeration Documentation

Action

enum ttv::social::SocialFriendRequestsTask::Action

strong

Enumerator
Unset
Fetch
MarkAllRead
GetUnreadCount

SortDirection

enum ttv::social::SocialFriendRequestsTask::SortDirection

strong

Enumerator
Descending
Ascending

Constructor & Destructor Documentation

SocialFriendRequestsTask()

ttv::social::SocialFriendRequestsTask::SocialFriendRequestsTask	(	UserId	userId,
		const std::string &	authToken,
		Callback	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FetchRequests()

void ttv::social::SocialFriendRequestsTask::FetchRequests	(	uint32_t	limit,
		SortDirection	sortDirection,
		const std::string &	cursor
	)

FillHttpRequestInfo()

virtual void ttv::social::SocialFriendRequestsTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::social::SocialFriendRequestsTask::GetTaskName ( ) const

inlineoverrideprotectedvirtual

Implements ttv::Task.

GetUnreadCount()

void ttv::social::SocialFriendRequestsTask::GetUnreadCount

(

)

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

MarkAllRead()

void ttv::social::SocialFriendRequestsTask::MarkAllRead

(

)

OnComplete()

virtual void ttv::social::SocialFriendRequestsTask::OnComplete ( )

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

ParseFriendRequestListJson()

bool ttv::social::SocialFriendRequestsTask::ParseFriendRequestListJson ( const json::Value &  jArray )

private

ProcessHeaders()

virtual bool ttv::social::SocialFriendRequestsTask::ProcessHeaders ( uint  statusCode, const std::map< std::string, std::string > &  headers  )

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

ProcessResponse()

virtual void ttv::social::SocialFriendRequestsTask::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.

Member Data Documentation

kMaxLimit

const uint32_t ttv::social::SocialFriendRequestsTask::kMaxLimit = 500

static

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mAction

Action ttv::social::SocialFriendRequestsTask::mAction

private

mCallback

Callback ttv::social::SocialFriendRequestsTask::mCallback

private

mCursor

std::string ttv::social::SocialFriendRequestsTask::mCursor

private

mLimit

uint32_t ttv::social::SocialFriendRequestsTask::mLimit

private

mResult

std::shared_ptr<Result> ttv::social::SocialFriendRequestsTask::mResult

private

mSortDirection

SortDirection ttv::social::SocialFriendRequestsTask::mSortDirection

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUserData

void* ttv::Task::mUserData

protectedinherited

mUserId

UserId ttv::social::SocialFriendRequestsTask::mUserId

private

---

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

• modules/social/social_common/include/twitchsdk/social/internal/task/socialfriendrequeststask.h