The BuddyList Manager interface More...

#include <IBuddyManager.h>

Inheritance diagram for Sfs2X::Entities::Managers::IBuddyManager:

Public Member Functions
virtual bool	Inited ()=0
	Checks if the current User's Buddy List is inited. More...

virtual void	Inited (bool value)=0
	Checks if the current User's Buddy List is inited. More...

virtual bool	ContainsBuddy (string name)=0
	Checks if a Buddy is present in the current User's Buddy List More...

virtual boost::shared_ptr< Buddy >	GetBuddyById (long int id)=0
	Find a Buddy from its User Id More...

virtual boost::shared_ptr< Buddy >	GetBuddyByName (string name)=0
	Find a Buddy from its name More...

virtual boost::shared_ptr< Buddy >	GetBuddyByNickName (string nickName)=0
	Find a Buddy from its optional nick name More...

virtual boost::shared_ptr< vector< boost::shared_ptr< Buddy > > >	OfflineBuddies ()=0
	Get a list of all online Buddies in the User's Buddy list More...

virtual boost::shared_ptr< vector< boost::shared_ptr< Buddy > > >	OnlineBuddies ()=0
	Get a list of all offline Buddies in the User's Buddy list More...

virtual boost::shared_ptr< vector< boost::shared_ptr< Buddy > > >	BuddyList ()=0
	Get the User's buddy list. It could be null if the Buddy List was not initialized More...

virtual boost::shared_ptr< vector< string > >	BuddyStates ()=0
	Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side. More...

virtual void	BuddyStates (boost::shared_ptr< vector< string > > value)=0
	Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side. More...

virtual boost::shared_ptr< BuddyVariable >	GetMyVariable (boost::shared_ptr< string > varName)=0
	Get current Users' BuddyVariable by name More...

virtual boost::shared_ptr< BuddyVariable >	GetMyVariable (string varName)=0
	Get current Users' BuddyVariable by name More...

virtual boost::shared_ptr< vector< boost::shared_ptr< BuddyVariable > > >	MyVariables ()=0
	Get all current User's Buddy Variables More...

virtual void	MyVariables (boost::shared_ptr< vector< boost::shared_ptr< BuddyVariable > > > value)=0
	Get all current User's Buddy Variables More...

virtual bool	MyOnlineState ()=0
	Get the current User's Online State More...

virtual void	MyOnlineState (bool value)=0
	Get the current User's Online State More...

virtual boost::shared_ptr< string >	MyNickName ()=0
	Get the current User's optional nickname More...

virtual void	MyNickName (string value)=0
	Get the current User's optional nickname More...

virtual boost::shared_ptr< string >	MyState ()=0
	Get the current User's optional custom state (e.g. "Available"; "Busy", "Be right back"...) More...

virtual void	MyState (string value)=0
	Get the current User's optional custom state (e.g. "Available"; "Busy", "Be right back"...) More...

Detailed Description

The BuddyList Manager interface

Member Function Documentation

◆ BuddyList()

virtual boost::shared_ptr<vector<boost::shared_ptr<Buddy> > > Sfs2X::Entities::Managers::IBuddyManager::BuddyList ( )

pure virtual

Get the User's buddy list. It could be null if the Buddy List was not initialized

See also: Requests.InitBuddyListRequest

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ BuddyStates() [1/2]

virtual boost::shared_ptr<vector<string> > Sfs2X::Entities::Managers::IBuddyManager::BuddyStates ( )

pure virtual

Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side.

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ BuddyStates() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::BuddyStates ( boost::shared_ptr< vector< string > > value )

pure virtual

Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side.

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ ContainsBuddy()

virtual bool Sfs2X::Entities::Managers::IBuddyManager::ContainsBuddy ( string name )

pure virtual

Checks if a Buddy is present in the current User's Buddy List

Parameters

name	the Buddy name

Returns: true if the Buddy exists

See also: SFSBuddy

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ GetBuddyById()

virtual boost::shared_ptr<Buddy> Sfs2X::Entities::Managers::IBuddyManager::GetBuddyById ( long int id )

pure virtual

Find a Buddy from its User Id

Parameters

id	the user id

Returns: the Buddy, or null if not found

See also: SFSBuddy

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ GetBuddyByName()

virtual boost::shared_ptr<Buddy> Sfs2X::Entities::Managers::IBuddyManager::GetBuddyByName ( string name )

pure virtual

Find a Buddy from its name

Parameters

name	the Buddy name

Returns: the Buddy, or null if not found

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ GetBuddyByNickName()

virtual boost::shared_ptr<Buddy> Sfs2X::Entities::Managers::IBuddyManager::GetBuddyByNickName ( string nickName )

pure virtual

Find a Buddy from its optional nick name

Parameters

nickName Athe nickname

Returns: the Buddy, or null if not found

See also: SFSBuddy

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ GetMyVariable() [1/2]

virtual boost::shared_ptr<BuddyVariable> Sfs2X::Entities::Managers::IBuddyManager::GetMyVariable ( boost::shared_ptr< string > varName )

pure virtual

Get current Users' BuddyVariable by name

Parameters

varName the variable name

Returns: Pointer to a BuddyVariable instance

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ GetMyVariable() [2/2]

virtual boost::shared_ptr<BuddyVariable> Sfs2X::Entities::Managers::IBuddyManager::GetMyVariable ( string varName )

pure virtual

Get current Users' BuddyVariable by name

Parameters

varName the variable name

Returns: Pointer to a BuddyVariable instance

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ Inited() [1/2]

virtual bool Sfs2X::Entities::Managers::IBuddyManager::Inited ( )

pure virtual

Checks if the current User's Buddy List is inited.

If not you should send an InitBuddyListRequest to the server in order to retrieve your persistent Buddy List data.

See also: Requests.InitBuddyListRequest

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ Inited() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::Inited ( bool value )

pure virtual

Checks if the current User's Buddy List is inited.

If not you should send an InitBuddyListRequest to the server in order to retrieve your persistent Buddy List data.

See also: Requests.InitBuddyListRequest

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyNickName() [1/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Managers::IBuddyManager::MyNickName ( )

pure virtual

Get the current User's optional nickname

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

Returns the Users' nickname or null if the nickname was never set

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyNickName() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::MyNickName ( string value )

pure virtual

Get the current User's optional nickname

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

Returns the Users' nickname or null if the nickname was never set

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyOnlineState() [1/2]

virtual bool Sfs2X::Entities::Managers::IBuddyManager::MyOnlineState ( )

pure virtual

Get the current User's Online State

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

Returns true if the User is online, false otherwise

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyOnlineState() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::MyOnlineState ( bool value )

pure virtual

Get the current User's Online State

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

Returns true if the User is online, false otherwise

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyState() [1/2]

virtual boost::shared_ptr<string> Sfs2X::Entities::Managers::IBuddyManager::MyState ( )

pure virtual

Get the current User's optional custom state (e.g. "Available"; "Busy", "Be right back"...)

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyState() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::MyState ( string value )

pure virtual

Get the current User's optional custom state (e.g. "Available"; "Busy", "Be right back"...)

This operation is valid only if the User's BuddyList has already been initialized
The value is handled by a reserved Buddy Variable

See also: ReservedBuddyVariables

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyVariables() [1/2]

virtual boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > Sfs2X::Entities::Managers::IBuddyManager::MyVariables ( )

pure virtual

Get all current User's Buddy Variables

This operation is valid only if the User's BuddyList has already been initialized

See also: SFSBuddyVariable

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ MyVariables() [2/2]

virtual void Sfs2X::Entities::Managers::IBuddyManager::MyVariables ( boost::shared_ptr< vector< boost::shared_ptr< BuddyVariable > > > value )

pure virtual

Get all current User's Buddy Variables

This operation is valid only if the User's BuddyList has already been initialized

See also: SFSBuddyVariable

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ OfflineBuddies()

virtual boost::shared_ptr<vector<boost::shared_ptr<Buddy> > > Sfs2X::Entities::Managers::IBuddyManager::OfflineBuddies ( )

pure virtual

Get a list of all online Buddies in the User's Buddy list

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

◆ OnlineBuddies()

virtual boost::shared_ptr<vector<boost::shared_ptr<Buddy> > > Sfs2X::Entities::Managers::IBuddyManager::OnlineBuddies ( )

pure virtual

Get a list of all offline Buddies in the User's Buddy list

Implemented in Sfs2X::Entities::Managers::SFSBuddyManager.

Public Member Functions

Detailed Description

Member Function Documentation

◆ BuddyList()

◆ BuddyStates() [1/2]

◆ BuddyStates() [2/2]

◆ ContainsBuddy()

◆ GetBuddyById()

◆ GetBuddyByName()

◆ GetBuddyByNickName()

◆ GetMyVariable() [1/2]

◆ GetMyVariable() [2/2]

◆ Inited() [1/2]

◆ Inited() [2/2]

◆ MyNickName() [1/2]

◆ MyNickName() [2/2]

◆ MyOnlineState() [1/2]

◆ MyOnlineState() [2/2]

◆ MyState() [1/2]

◆ MyState() [2/2]

◆ MyVariables() [1/2]

◆ MyVariables() [2/2]

◆ OfflineBuddies()

◆ OnlineBuddies()