SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
Loading...
Searching...
No Matches
sfs3::requests::buddy::InitBuddyListRequest Class Reference

Initializes the Buddy List system on the current client. More...

#include <InitBuddyListRequest.h>

Inheritance diagram for sfs3::requests::buddy::InitBuddyListRequest:
[legend]

Public Member Functions

 InitBuddyListRequest ()
 Creates a new InitBuddyListRequest.

Detailed Description

Initializes the Buddy List system on the current client.

Buddy List system initialization involves loading any previously stored buddy-specific data from the server, such as the current user's buddies list, his previous state and the persistent Buddy Variables. The initialization request is the first operation to be executed in order to be able to use the Buddy List system features.

Once the initialization is completed, the event::SFSEvent::BUDDY_LIST_INIT event is fired and the user has access to all his previously set data and can start to interact with his buddies; if the initialization failed, a event::SFSEvent::BUDDY_ERROR event is fired.

See also
event::SFSEvent::BUDDY_LIST_INIT
event::SFSEvent::BUDDY_ERROR

Constructor & Destructor Documentation

◆ InitBuddyListRequest()

sfs3::requests::buddy::InitBuddyListRequest::InitBuddyListRequest ( )
inline

Creates a new InitBuddyListRequest.

Pass it to SmartFox::send for the request to be performed.

See also
SmartFox::send

The documentation for this class was generated from the following files:
  • requests/buddylist/InitBuddyListRequest.h
  • requests/buddylist/InitBuddyListRequest.cpp