sfs3::event::UserFindResult Struct Reference

Dispatched when a users search is completed. More...

#include <SFSEvent.h>

Public Attributes
std::vector< std::shared_ptr< entities::User > >	userList
	The users that match the search criteria.

Detailed Description

Dispatched when a users search is completed.

Sent in response to a requests::FindUsersRequest, with the result of the search.

See also

requests::FindUsersRequest

Member Data Documentation

userList

std::vector<std::shared_ptr<entities::User> > sfs3::event::UserFindResult::userList

The users that match the search criteria.

The list is empty when no user is found — a search scope the server refused (unknown Room, private Group) also gives an empty list, not an error.

The users are detached snapshots taken when the server ran the search: they belong to no user manager and are not kept up to date. The only exception is the requester himself, returned as the live SmartFox::getMySelf instance, so that his isItMe flag reads correctly.

---

The documentation for this struct was generated from the following file:

• event/SFSEvent.h