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

Removes a buddy from the current user's buddies list. More...

#include <RemoveBuddyRequest.h>

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

Public Member Functions

 RemoveBuddyRequest (std::string buddyName)
 Creates a new RemoveBuddyRequest.

Detailed Description

Removes a buddy from the current user's buddies list.

In order to remove a buddy, the current user must be online in the Buddy List system. If the buddy is removed successfully, the operation is confirmed by a event::SFSEvent::BUDDY_REMOVE event; otherwise the event::SFSEvent::BUDDY_ERROR event is fired.

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description).

See also
event::SFSEvent::BUDDY_REMOVE
event::SFSEvent::BUDDY_ERROR
AddBuddyRequest
InitBuddyListRequest

Constructor & Destructor Documentation

◆ RemoveBuddyRequest()

sfs3::requests::buddy::RemoveBuddyRequest::RemoveBuddyRequest ( std::string buddyName)
inline

Creates a new RemoveBuddyRequest.

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

Parameters
buddyNameThe name of the buddy to be removed from the user's buddies list.
See also
SmartFox::send

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