RakNet::Emails_Delete Struct Reference
[Lobby2Commands]
Deletes an email with a specified ID. This ID is returned in GetEmail and should uniquely identify an email (it's fine to use the primary key). Note: Emails are not actually deleted from the database in this function. This just sets the deletedBySender or deletedByReciever flags. Emails are actually stored in a log recording past emails and sender and receiver primary key. They are not truly destroyed until done so with System_PruneAccounts.
More...
#include <Lobby2Message.h>
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(). | |
Detailed Description
Deletes an email with a specified ID. This ID is returned in GetEmail and should uniquely identify an email (it's fine to use the primary key). Note: Emails are not actually deleted from the database in this function. This just sets the deletedBySender or deletedByReciever flags. Emails are actually stored in a log recording past emails and sender and receiver primary key. They are not truly destroyed until done so with System_PruneAccounts.Member Function Documentation
| virtual bool RakNet::Emails_Delete::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::Emails_Delete::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::Emails_Delete::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::Emails_Delete::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.
The documentation for this struct was generated from the following file:
- d:/temp/RakNet_PC/DependentExtensions/Lobby2/Lobby2Message.h
