sfs3::entities::ReservedBuddyVariables Namespace Reference

The names the SmartFoxServer API reserves for the Buddy Variables that hold buddy-related information. More...

Variables
const std::string	BV_ONLINE = "$__BV_ONLINE__"
	The Buddy Variable keeping track of the online/offline state of the user in a buddy list.
const std::string	BV_STATE = "$__BV_STATE__"
	The Buddy Variable storing the custom state of the user in a buddy list.
const std::string	BV_NICKNAME = "$__BV_NICKNAME__"
	The Buddy Variable storing the optional nickname of the user in a buddy list.

Detailed Description

The names the SmartFoxServer API reserves for the Buddy Variables that hold buddy-related information.

All three are persistent (their names start with the offline prefix), so the state they describe survives a disconnection.

See also

Buddy

SFSBuddyVariable

Variable Documentation

BV_ONLINE

const std::string sfs3::entities::ReservedBuddyVariables::BV_ONLINE = "$__BV_ONLINE__"

inline

The Buddy Variable keeping track of the online/offline state of the user in a buddy list.

See also

Buddy::isOnline

BV_STATE

const std::string sfs3::entities::ReservedBuddyVariables::BV_STATE = "$__BV_STATE__"

inline

The Buddy Variable storing the custom state of the user in a buddy list.

See also

Buddy::getState

BV_NICKNAME

const std::string sfs3::entities::ReservedBuddyVariables::BV_NICKNAME = "$__BV_NICKNAME__"

inline

The Buddy Variable storing the optional nickname of the user in a buddy list.

See also

Buddy::getNickName