Swiften/Roster/XMPPRoster.h

/*
 * Copyright (c) 2010 Remko Tronçon
 * Licensed under the GNU General Public License v3.
 * See Documentation/Licenses/GPLv3.txt for more information.
 */

#pragma once

#include <boost/optional.hpp>
#include <vector>
#include <set>
#include <Swiften/Base/boost_bsignals.h>

#include <string>
#include <Swiften/JID/JID.h>
#include <Swiften/Elements/RosterItemPayload.h>
#include <Swiften/Roster/XMPPRosterItem.h>

namespace Swift {
  class XMPPRoster {
    public:
      XMPPRoster();
      virtual ~XMPPRoster();

      virtual bool containsJID(const JID& jid) = 0;

      virtual RosterItemPayload::Subscription getSubscriptionStateForJID(const JID& jid) = 0;

      virtual std::string getNameForJID(const JID& jid) const = 0;

      virtual std::vector<std::string> getGroupsForJID(const JID& jid) = 0;

      virtual std::vector<XMPPRosterItem> getItems() const = 0;

      virtual boost::optional<XMPPRosterItem> getItem(const JID&) const = 0;

      virtual std::set<std::string> getGroups() const = 0;

    public:
      boost::signal<void (const JID&)> onJIDAdded;

      boost::signal<void (const JID&)> onJIDRemoved;

      boost::signal<void (const JID&, const std::string&, const std::vector<std::string>&)> onJIDUpdated;

      boost::signal<void ()> onRosterCleared;

      boost::signal<void ()> onInitialRosterPopulated;
  };
}