RakNet  4.0
Public Member Functions | Public Attributes | List of all members
RakNet::Emails_Get Struct Reference

Returns emails as noted. Emails which were marked deleted are not returned. More...

#include <Lobby2Message.h>

Inheritance diagram for RakNet::Emails_Get:
RakNet::Lobby2Message

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 Member Functions inherited from RakNet::Lobby2Message
virtual Lobby2MessageID GetID (void) const =0
 Every message has an ID identifying it across the network.
 
virtual bool PrevalidateInput (void)
 
virtual bool ClientImpl (RakNet::Lobby2Plugin *client)
 
virtual void CallCallback (Lobby2Callbacks *cb)=0
 
virtual bool ServerPreDBMemoryImpl (Lobby2Server *server, RakString userHandle)
 
virtual void ServerPostDBMemoryImpl (Lobby2Server *server, RakString userHandle)
 Do any Lobby2Server functionality after the message has been processed by the database, in the server thread.
 
virtual bool ServerDBImpl (Lobby2ServerCommand *command, void *databaseInterface)
 
bool ValidateHandle (RakNet::RakString *handle)
 
bool ValidateBinary (RakNetSmartPtr< BinaryDataBlock >binaryDataBlock)
 Binary data cannot be longer than L2_MAX_BINARY_DATA_LENGTH.
 
bool ValidateRequiredText (RakNet::RakString *text)
 Required text cannot be empty.
 
bool ValidatePassword (RakNet::RakString *text)
 Passwords must contain at least 5 characters.
 
bool ValidateEmailAddress (RakNet::RakString *text)
 Check email address format.
 
virtual const char * GetName (void) const =0
 Convert the enumeration representing this message to a string, and return it. Done automatically by macros.
 
virtual void DebugMsg (RakNet::RakString &out) const =0
 Write the result of this message to out(). Done automatically by macros.
 
virtual void DebugPrintf (void) const
 Print the result of DebugMsg.
 

Public Attributes

DataStructures::List< EmailResult > emailResults
 
- Public Attributes inherited from RakNet::Lobby2Message
RakNet::Lobby2ResultCode resultCode
 Result of the operation. L2RC_SUCCESS means the result completed. Anything else means an error.
 
uint32_t callbackId
 
int extendedResultCode
 Used for consoles.
 
uint64_t requestId
 

Detailed Description

Returns emails as noted. Emails which were marked deleted are not returned.

Member Function Documentation

virtual bool RakNet::Emails_Get::CancelOnDisconnect ( void  ) const
inlinevirtual

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_Get::RequiresAdmin ( void  ) const
inlinevirtual

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_Get::RequiresLogin ( void  ) const
inlinevirtual

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_Get::RequiresRankingPermission ( void  ) const
inlinevirtual

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

DataStructures::List<EmailResult> RakNet::Emails_Get::emailResults
Parameters
[out]emailResultsUp to caller to deallocate binary data

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