JoinRoomInvitationRequest.h

// ===================================================================
//
// Description      
//      Contains the definition of JoinRoomInvitationRequest
//
// Revision history
//      Date            Description
//      30-Nov-2016     First version
//
// ===================================================================
#ifndef __JoinRoomInvitationRequest__
#define __JoinRoomInvitationRequest__

#include "../../Util/Common.h"
#include "../BaseRequest.h"
#include "../../Entities/Data/ISFSObject.h"
#include "../../Entities/Room.h"

#include <boost/shared_ptr.hpp>             // Boost Asio shared pointer

#if defined(_MSC_VER)
#pragma warning(disable:4786)           // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
#endif
#include <list>                         // STL library: list object
#include <string>                       // STL library: string object
using namespace std;                    // STL library: declare the STL namespace

using namespace Sfs2X::Entities::Data;

namespace Sfs2X {
namespace Requests {
namespace Game {

    class DLLImportExport JoinRoomInvitationRequest : public BaseRequest
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------

        JoinRoomInvitationRequest(boost::shared_ptr<Room> targetRoom, boost::shared_ptr<list<string> > invitedUserNames, boost::shared_ptr<ISFSObject> parameters, long int expirySeconds, bool asSpectator);

        JoinRoomInvitationRequest(boost::shared_ptr<Room> targetRoom, boost::shared_ptr<list<string> > invitedUserNames, boost::shared_ptr<ISFSObject> parameters, long int expirySeconds);

        JoinRoomInvitationRequest(boost::shared_ptr<Room> targetRoom, boost::shared_ptr<list<string> > invitedUserNames, boost::shared_ptr<ISFSObject> parameters);

        JoinRoomInvitationRequest(boost::shared_ptr<Room> targetRoom, boost::shared_ptr<list<string> > invitedUserNames);

        virtual ~JoinRoomInvitationRequest();

        void Validate(boost::shared_ptr<SmartFox> sfs);

        void Execute (boost::shared_ptr<SmartFox> sfs);

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------
    
        static boost::shared_ptr<string> KEY_ROOM_ID;

        static boost::shared_ptr<string> KEY_EXPIRY_SECONDS;

        static boost::shared_ptr<string> KEY_INVITED_NAMES;

        static boost::shared_ptr<string> KEY_AS_SPECT;

        static boost::shared_ptr<string> KEY_OPTIONAL_PARAMS;

    protected:

        // -------------------------------------------------------------------
        // Protected methods
        // -------------------------------------------------------------------

        // -------------------------------------------------------------------
        // Protected members
        // -------------------------------------------------------------------

    private:

        // -------------------------------------------------------------------
        // Private methods
        // -------------------------------------------------------------------
        void Init(boost::shared_ptr<Room> targetRoom, boost::shared_ptr<list<string> > invitedUserNames, boost::shared_ptr<ISFSObject> parameters, long int expirySeconds, bool asSpectator);

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        boost::shared_ptr<Room> targetRoom;
        boost::shared_ptr<list<string> > invitedUserNames;
        long int expirySeconds;
        bool asSpectator;
        boost::shared_ptr<ISFSObject> parameters;
    };

}   // namespace Game
}   // namespace Requests
}   // namespace Sfs2X

#endif