privacyitem.h

/*
  Copyright (c) 2005-2012 by Jakob Schroeter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/


#ifndef PRIVACYITEM_H__
#define PRIVACYITEM_H__

#include "macros.h"
#include "gloox.h"

#include <string>

namespace gloox
{

  class GLOOX_API PrivacyItem
  {
    public:

      enum ItemType
      {
        TypeUndefined,              
        TypeJid,                    
        TypeGroup,                  
        TypeSubscription            
      };

      enum ItemAction
      {
        ActionAllow,                
        ActionDeny                  
      };

      enum ItemPacketType
      {
        PacketMessage        =  1,  
        PacketPresenceIn     =  2,  
        PacketPresenceOut    =  4,  
        PacketIq             =  8,  
        PacketAll            = 15   
      };

      PrivacyItem( const ItemType type = TypeUndefined, const ItemAction action = ActionAllow,
                   const int packetType = 0, const std::string& value = EmptyString );

      virtual ~PrivacyItem();

      ItemType type() const { return m_type; }

      ItemAction action() const { return m_action; }

      int packetType() const { return m_packetType; }

      const std::string value() const { return m_value; }

      bool operator==( const PrivacyItem& item ) const;

    private:
      ItemType m_type;
      ItemAction m_action;
      int m_packetType;
      std::string m_value;
  };

}

#endif // PRIVACYITEM_H__