ttv::chat::UserEmoticonSets Class Reference

#include <useremoticonsets.h>

Inheritance diagram for ttv::chat::UserEmoticonSets:

Public Types
using	FetchEmoticonSetsCallback = std::function< void(TTV_ErrorCode ec, const std::vector< EmoticonSet > &result)>
using	DisposerFunc = std::function< void()>
enum	State { State::Uninitialized, State::Initialized, State::ShuttingDown, State::Inert }

Public Member Functions
	UserEmoticonSets (const std::shared_ptr< User > &user, const TokenizationOptions &options)
virtual	~UserEmoticonSets ()
virtual TTV_ErrorCode	Initialize () override
virtual void	Update () override
virtual TTV_ErrorCode	Shutdown () override
virtual std::string	GetLoggerName () const override
TTV_ErrorCode	GetUserEmoticonSets (std::vector< EmoticonSet > &sets)
TTV_ErrorCode	FetchUserEmoticonSets (bool forceFetch, const FetchEmoticonSetsCallback &callback)
TokenizationOptions	GetTokenizationOptions () const
void	OnTopicSubscribeStateChanged (const std::string &topic, PubSubClient::SubscribeState::Enum state, TTV_ErrorCode ec) override
void	OnTopicMessageReceived (const std::string &topic, const ttv::json::Value &jVal) override
virtual void	CompleteShutdown () override
void	SetListener (const std::shared_ptr< UserEmoticonSetsListener > &listener)
void	SetDisposer (DisposerFunc &&func)
TTV_ErrorCode	Dispose ()
virtual void	OnTopicListenerRemoved (const std::string &topic, TTV_ErrorCode ec)
virtual void	SetTaskRunner (std::shared_ptr< TaskRunner > taskRunner)
std::shared_ptr< TaskRunner >	GetTaskRunner ()
virtual State	GetState () const override

Static Public Member Functions
static std::string	GetComponentName ()

Protected Member Functions
virtual bool	CheckShutdown () override
virtual void	AddTopic (const std::string &topic)
virtual TTV_ErrorCode	SubscribeTopics ()
virtual void	OnUserLogInComplete (TTV_ErrorCode ec)
virtual void	OnUserLogOutComplete (TTV_ErrorCode ec)
virtual void	OnUserInfoFetchComplete (TTV_ErrorCode ec)
virtual void	OnUserAuthenticationIssue (std::shared_ptr< const OAuthToken > oauthToken, TTV_ErrorCode ec)
void	Log (TTV_MessageLevel level, const char *format,...)
TTV_ErrorCode	StartTask (std::shared_ptr< Task > task)
void	CompleteTask (Task *task)
bool	IsTaskRunning (Task *task) const
virtual void	SetState (State state)
virtual void	SetClientState (State state)
virtual void	SetServerState (State state)

Protected Attributes
std::shared_ptr< UserEmoticonSetsListener >	mListener
std::shared_ptr< PubSubClient >	mPubSub
std::shared_ptr< PubSubTopicListener >	mPubSubTopicListener
std::shared_ptr< PubSubTopicListenerHelper >	mPubSubTopicListenerHelper
DisposerFunc	mDisposerFunc
std::vector< std::string >	mPubSubTopics
std::weak_ptr< User >	mUser
bool	mOAuthIssue
	Whether or not the internal updates of the component are on hold because of an issue with the OAuth token. More...
ClientServerValue< State >	mState
std::shared_ptr< TaskRunner >	mTaskRunner
std::vector< std::shared_ptr< Task > >	mRunningTasks
std::mutex	mTaskMutex
uint64_t	mShutdownTimeMilliseconds

Private Attributes
CallbackQueue< FetchEmoticonSetsCallback >	mFetchUserEmoticonSetsCallbacks
std::vector< EmoticonSet >	mUserEmoticonSets
std::string	mPubSubTopic
RetryTimer	mFetchRetryTimer
TokenizationOptions	mTokenizationOptions
bool	mEmoticonFetchInFlight

Detailed Description

Fetches and keeps track of the list of emoticons available for a user.

Member Typedef Documentation

DisposerFunc

using ttv::PubSubComponentBase::DisposerFunc = std::function<void()>

inherited

FetchEmoticonSetsCallback

using ttv::chat::UserEmoticonSets::FetchEmoticonSetsCallback = std::function<void(TTV_ErrorCode ec, const std::vector<EmoticonSet>& result)>

Member Enumeration Documentation

State

enum ttv::IComponent::State

stronginherited

Enumerator
Uninitialized
Initialized
ShuttingDown
Inert	The component doesn't require shutting down.

Constructor & Destructor Documentation

UserEmoticonSets()

ttv::chat::UserEmoticonSets::UserEmoticonSets	(	const std::shared_ptr< User > &	user,
		const TokenizationOptions &	options
	)

~UserEmoticonSets()

virtual ttv::chat::UserEmoticonSets::~UserEmoticonSets ( )

virtual

Member Function Documentation

AddTopic()

virtual void ttv::PubSubComponentBase::AddTopic ( const std::string &  topic )

protectedvirtualinherited

CheckShutdown()

virtual bool ttv::PubSubComponentBase::CheckShutdown ( )

overrideprotectedvirtualinherited

Reimplemented from ttv::Component.

Reimplemented in ttv::ChannelStatus, and ttv::ProfileImageStatus.

CompleteShutdown()

virtual void ttv::PubSubComponent< UserEmoticonSetsListener >::CompleteShutdown ( )

inlineoverridevirtualinherited

Reimplemented from ttv::PubSubComponentBase.

CompleteTask()

void ttv::Component::CompleteTask ( Task *  task )

protectedinherited

Dispose()

TTV_ErrorCode ttv::PubSubComponentBase::Dispose ( )

inherited

FetchUserEmoticonSets()

TTV_ErrorCode ttv::chat::UserEmoticonSets::FetchUserEmoticonSets	(	bool	forceFetch,
		const FetchEmoticonSetsCallback &	callback
	)

Fetches and returns the user's currently available emoticon sets.

Parameters

[in]	forceFetch	If true, will force a refetch for the latest values. If false, will returned currently stored values.
[in]	callback	Function to be called that will take in the list of user emoticon sets.

GetComponentName()

static std::string ttv::chat::UserEmoticonSets::GetComponentName ( )

inlinestatic

GetLoggerName()

virtual std::string ttv::chat::UserEmoticonSets::GetLoggerName ( ) const

overridevirtual

Implements ttv::PubSubComponentBase.

GetState()

virtual State ttv::Component::GetState ( ) const

overridevirtualinherited

Implements ttv::IComponent.

GetTaskRunner()

std::shared_ptr<TaskRunner> ttv::Component::GetTaskRunner ( )

inlineinherited

GetTokenizationOptions()

TokenizationOptions ttv::chat::UserEmoticonSets::GetTokenizationOptions ( ) const

inline

Returns the currently configured tokenization options.

GetUserEmoticonSets()

TTV_ErrorCode ttv::chat::UserEmoticonSets::GetUserEmoticonSets

(

std::vector< EmoticonSet > &

sets

)

Returns the user's currently available emoticon sets.

Initialize()

virtual TTV_ErrorCode ttv::chat::UserEmoticonSets::Initialize ( )

overridevirtual

Reimplemented from ttv::PubSubComponentBase.

IsTaskRunning()

bool ttv::Component::IsTaskRunning ( Task *  task ) const

protectedinherited

Log()

void ttv::UserComponent::Log ( TTV_MessageLevel  level, const char *  format,   ...  )

protectedinherited

OnTopicListenerRemoved()

virtual void ttv::PubSubComponentBase::OnTopicListenerRemoved ( const std::string &  topic, TTV_ErrorCode  ec  )

virtualinherited

OnTopicMessageReceived()

void ttv::chat::UserEmoticonSets::OnTopicMessageReceived ( const std::string &  topic, const ttv::json::Value &  jVal  )

overridevirtual

Listens for new subscriptions to kick off a fetch for the newest emoticons.

Implements ttv::PubSubComponentBase.

OnTopicSubscribeStateChanged()

void ttv::chat::UserEmoticonSets::OnTopicSubscribeStateChanged ( const std::string &  topic, PubSubClient::SubscribeState::Enum  state, TTV_ErrorCode  ec  )

overridevirtual

Implements ttv::PubSubComponentBase.

OnUserAuthenticationIssue()

virtual void ttv::UserComponent::OnUserAuthenticationIssue ( std::shared_ptr< const OAuthToken >  oauthToken, TTV_ErrorCode  ec  )

protectedvirtualinherited

OnUserInfoFetchComplete()

virtual void ttv::UserComponent::OnUserInfoFetchComplete ( TTV_ErrorCode  ec )

protectedvirtualinherited

Reimplemented in ttv::social::FriendList, ttv::social::Presence, and ttv::chat::ChatUserThreads.

OnUserLogInComplete()

virtual void ttv::UserComponent::OnUserLogInComplete ( TTV_ErrorCode  ec )

protectedvirtualinherited

OnUserLogOutComplete()

virtual void ttv::UserComponent::OnUserLogOutComplete ( TTV_ErrorCode  ec )

protectedvirtualinherited

SetClientState()

virtual void ttv::Component::SetClientState ( State  state )

protectedvirtualinherited

SetDisposer()

void ttv::PubSubComponentBase::SetDisposer ( DisposerFunc &&  func )

inlineinherited

SetListener()

void ttv::PubSubComponent< UserEmoticonSetsListener >::SetListener ( const std::shared_ptr< UserEmoticonSetsListener > &  listener )

inlineinherited

SetServerState()

virtual void ttv::Component::SetServerState ( State  state )

protectedvirtualinherited

SetState()

virtual void ttv::Component::SetState ( State  state )

protectedvirtualinherited

SetTaskRunner()

virtual void ttv::Component::SetTaskRunner ( std::shared_ptr< TaskRunner >  taskRunner )

virtualinherited

Reimplemented in ttv::broadcast::Streamer, and ttv::social::FriendList.

Shutdown()

virtual TTV_ErrorCode ttv::chat::UserEmoticonSets::Shutdown ( )

overridevirtual

Reimplemented from ttv::PubSubComponentBase.

StartTask()

TTV_ErrorCode ttv::Component::StartTask ( std::shared_ptr< Task >  task )

protectedinherited

SubscribeTopics()

virtual TTV_ErrorCode ttv::PubSubComponentBase::SubscribeTopics ( )

protectedvirtualinherited

Update()

virtual void ttv::chat::UserEmoticonSets::Update ( )

overridevirtual

Reimplemented from ttv::Component.

Member Data Documentation

mDisposerFunc

DisposerFunc ttv::PubSubComponentBase::mDisposerFunc

protectedinherited

mEmoticonFetchInFlight

bool ttv::chat::UserEmoticonSets::mEmoticonFetchInFlight

private

mFetchRetryTimer

RetryTimer ttv::chat::UserEmoticonSets::mFetchRetryTimer

private

mFetchUserEmoticonSetsCallbacks

CallbackQueue<FetchEmoticonSetsCallback> ttv::chat::UserEmoticonSets::mFetchUserEmoticonSetsCallbacks

private

mListener

std::shared_ptr<UserEmoticonSetsListener > ttv::PubSubComponent< UserEmoticonSetsListener >::mListener

protectedinherited

mOAuthIssue

bool ttv::UserComponent::mOAuthIssue

protectedinherited

Whether or not the internal updates of the component are on hold because of an issue with the OAuth token.

mPubSub

std::shared_ptr<PubSubClient> ttv::PubSubComponentBase::mPubSub

protectedinherited

mPubSubTopic

std::string ttv::chat::UserEmoticonSets::mPubSubTopic

private

mPubSubTopicListener

std::shared_ptr<PubSubTopicListener> ttv::PubSubComponentBase::mPubSubTopicListener

protectedinherited

mPubSubTopicListenerHelper

std::shared_ptr<PubSubTopicListenerHelper> ttv::PubSubComponentBase::mPubSubTopicListenerHelper

protectedinherited

mPubSubTopics

std::vector<std::string> ttv::PubSubComponentBase::mPubSubTopics

protectedinherited

mRunningTasks

std::vector<std::shared_ptr<Task> > ttv::Component::mRunningTasks

protectedinherited

mShutdownTimeMilliseconds

uint64_t ttv::Component::mShutdownTimeMilliseconds

protectedinherited

mState

ClientServerValue<State> ttv::Component::mState

protectedinherited

mTaskMutex

std::mutex ttv::Component::mTaskMutex

mutableprotectedinherited

mTaskRunner

std::shared_ptr<TaskRunner> ttv::Component::mTaskRunner

protectedinherited

mTokenizationOptions

TokenizationOptions ttv::chat::UserEmoticonSets::mTokenizationOptions

private

mUser

std::weak_ptr<User> ttv::UserComponent::mUser

protectedinherited

mUserEmoticonSets

std::vector<EmoticonSet> ttv::chat::UserEmoticonSets::mUserEmoticonSets

private

---

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

• modules/chat/chat_common/include/twitchsdk/chat/internal/useremoticonsets.h