summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2016-12-08 09:22:52 (GMT)
committerEdwin Mons <edwin.mons@isode.com>2016-12-09 08:30:45 (GMT)
commit7b34ce22fd646c252791a3eda5005178ab3f19bf (patch)
tree79f99ecd31e90d37a2179e0b026eaf691cac0deb /Swift/Controllers
parentda7162b6e80ed6ce802bece3891fe85f30770c56 (diff)
downloadswift-7b34ce22fd646c252791a3eda5005178ab3f19bf.zip
swift-7b34ce22fd646c252791a3eda5005178ab3f19bf.tar.bz2
Improve documentation of code related to impromptu chats
Test-Information: Builds and all tests pass on macOS 10.12.1. Change-Id: I58ca7ba27736d27426350f636dfe910f4f2f1b17
Diffstat (limited to 'Swift/Controllers')
-rw-r--r--Swift/Controllers/Chat/ChatsManager.cpp2
-rw-r--r--Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h10
2 files changed, 11 insertions, 1 deletions
diff --git a/Swift/Controllers/Chat/ChatsManager.cpp b/Swift/Controllers/Chat/ChatsManager.cpp
index 4f95d71..f55df1e 100644
--- a/Swift/Controllers/Chat/ChatsManager.cpp
+++ b/Swift/Controllers/Chat/ChatsManager.cpp
@@ -587,7 +587,7 @@ void ChatsManager::handleUIEvent(std::shared_ptr<UIEvent> event) {
std::shared_ptr<CreateImpromptuMUCUIEvent> createImpromptuMUCEvent = std::dynamic_pointer_cast<CreateImpromptuMUCUIEvent>(event);
if (createImpromptuMUCEvent) {
assert(!localMUCServiceJID_.toString().empty());
- // create new muc
+ // The room JID is random for new impromptu rooms, or a predefined JID for impromptu rooms resumed from the 'Recent chats' list.
JID roomJID = createImpromptuMUCEvent->getRoomJID().toString().empty() ? JID(idGenerator_.generateID(), localMUCServiceJID_) : createImpromptuMUCEvent->getRoomJID();
// join muc
diff --git a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h
index 22ce926..e420bad 100644
--- a/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h
+++ b/Swift/Controllers/UIEvents/CreateImpromptuMUCUIEvent.h
@@ -23,11 +23,21 @@ namespace Swift {
class CreateImpromptuMUCUIEvent : public UIEvent {
public:
+ /**
+ * @brief CreateImpromptuMUCUIEvent
+ * @param jids A vector of JIDs that are invited to the imprompto MUC.
+ * Useful when the event is used to recreate an old impromptu
+ * chat room.
+ * @param roomJID The full JID of the impromtu MUC. Useful when the event
+ * is used to recreate an old impromptu chat room.
+ * @param reason
+ */
CreateImpromptuMUCUIEvent(const std::vector<JID>& jids, const JID& roomJID = JID(), const std::string reason = "") : jids_(jids), roomJID_(roomJID), reason_(reason) { }
std::vector<JID> getJIDs() const { return jids_; }
JID getRoomJID() const { return roomJID_; }
std::string getReason() const { return reason_; }
+
private:
std::vector<JID> jids_;
JID roomJID_;