ttv::social::SocialGetFriendsPresenceTask Class Reference

#include <socialgetfriendspresencetask.h>

Inheritance diagram for ttv::social::SocialGetFriendsPresenceTask:

Classes
struct	PresenceEntry
struct	Result

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

Public Member Functions
	SocialGetFriendsPresenceTask (UserId userId, const std::string &authToken, Callback callback)
virtual void	Run () override
virtual void	Abort ()

Static Public Attributes
static const uint32_t	kMaxLimit = 500

Protected Member Functions
virtual const char *	GetTaskName () const
virtual void	FillHttpRequestInfo (HttpRequestInfo &requestInfo)
virtual bool	ProcessHeaders (uint statusCode, const std::map< std::string, std::string > &headers)
virtual void	ProcessResponse (uint statusCode, const std::vector< char > &response)
virtual void	OnComplete ()
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 Attributes
std::shared_ptr< Result >	mResult
Callback	mCallback
UserId	mUserId

---

Class Documentation

ttv::social::SocialGetFriendsPresenceTask::PresenceEntry

struct ttv::social::SocialGetFriendsPresenceTask::PresenceEntry

Class Members
Friend	friendData
uint64_t	presenceUpdateIndex

ttv::social::SocialGetFriendsPresenceTask::Result

struct ttv::social::SocialGetFriendsPresenceTask::Result

Class Members
vector< PresenceEntry >	presenceList

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

SocialGetFriendsPresenceTask()

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

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

protectedvirtual

Implements ttv::HttpTask.

GetTaskName()

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

inlineprotectedvirtual

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::social::SocialGetFriendsPresenceTask::OnComplete ( )

protectedvirtual

Reimplemented from ttv::HttpTask.

ProcessHeaders()

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

protectedvirtual

Reimplemented from ttv::HttpTask.

ProcessResponse()

virtual void ttv::social::SocialGetFriendsPresenceTask::ProcessResponse ( uint  statusCode, const std::vector< char > &  response  )

protectedvirtual

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::SocialGetFriendsPresenceTask::kMaxLimit = 500

static

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::social::SocialGetFriendsPresenceTask::mCallback

private

mResult

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

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUserData

void* ttv::Task::mUserData

protectedinherited

mUserId

UserId ttv::social::SocialGetFriendsPresenceTask::mUserId

private

---

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

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