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

Sets one or more Buddy Variables for the current user. More...

#include <SetBuddyVariablesRequest.h>

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

Public Member Functions

 SetBuddyVariablesRequest (std::vector< std::shared_ptr< entities::BuddyVariable > > buddyVariables)
 Creates a new SetBuddyVariablesRequest.

Detailed Description

Sets one or more Buddy Variables for the current user.

This operation updates the Buddy object representing the user in all the buddies lists in which the user was added as a buddy. If the operation is successful, a event::SFSEvent::BUDDY_VARIABLES_UPDATE event is dispatched to all the owners of those buddies lists and to the user who updated his variables too.

NOTE: this request can be sent if the Buddy List system was previously initialized only (see the InitBuddyListRequest request description) and the current user state in the system is "online".

See also
entities::SFSBuddyVariable
event::SFSEvent::BUDDY_VARIABLES_UPDATE
InitBuddyListRequest

Constructor & Destructor Documentation

◆ SetBuddyVariablesRequest()

sfs3::requests::buddy::SetBuddyVariablesRequest::SetBuddyVariablesRequest ( std::vector< std::shared_ptr< entities::BuddyVariable > > buddyVariables)
inline

Creates a new SetBuddyVariablesRequest.

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

Parameters
buddyVariablesThe Buddy Variables to be set. Null entries are skipped when the request is serialized.
See also
SmartFox::send
entities::SFSBuddyVariable

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