RakNet::BookmarkedUsers_Get Struct Reference
[Lobby2Commands]

Returns all users added to BookmarkedUsers_Add. More...

#include <Lobby2Message.h>

Inheritance diagram for RakNet::BookmarkedUsers_Get:

RakNet::Lobby2Message

List of all members.

Public Member Functions

virtual bool RequiresAdmin (void) const
virtual bool RequiresRankingPermission (void) const
virtual bool CancelOnDisconnect (void) const
virtual bool RequiresLogin (void) const
virtual void Serialize (bool writeToBitstream, bool serializeOutput, RakNet::BitStream *bitStream)
 Overridable serialization of the contents of this message. Defaults to SerializeBase().

Public Attributes

DataStructures::List
< BookmarkedUser > 
bookmarkedUsers


Detailed Description

Returns all users added to BookmarkedUsers_Add.

Member Function Documentation

virtual bool RakNet::BookmarkedUsers_Get::CancelOnDisconnect ( void   )  const [inline, virtual]

Should this message not be processed on the server if the requesting user disconnects before it completes? This should be true for functions that only return data. False for functions that affect other users, or change the database

Implements RakNet::Lobby2Message.

virtual bool RakNet::BookmarkedUsers_Get::RequiresAdmin ( void   )  const [inline, virtual]

Is this message something that should only be run by a system with admin privileges? Set admin privileges with Lobby2Server::AddAdminAddress()

Implements RakNet::Lobby2Message.

virtual bool RakNet::BookmarkedUsers_Get::RequiresLogin ( void   )  const [inline, virtual]

Does this function require logging into the server before it can be executed? If true, the user id and user handle will be automatically inferred by the last login by looking up the sender's system address. If false, the message should include the username so the database query can lookup which user is performing this operation.

Implements RakNet::Lobby2Message.

virtual bool RakNet::BookmarkedUsers_Get::RequiresRankingPermission ( void   )  const [inline, virtual]

Is this message something that should only be run by a system with ranking upload priviledges? Set ranking privileges with Lobby2Server::AddRankingAddress()

Implements RakNet::Lobby2Message.


Member Data Documentation

Parameters:
[out] recentlyMetUsers Handles of recently met users, by BookmarkedUsers_Add, subject to expirationTimeSeconds


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

Generated on Wed Feb 1 13:33:49 2012 for RakNet by  doxygen 1.5.7.1