Comments documenting home-grown <presence> whitelist attribute.

1 files changed, 13 insertions, 0 deletions

diff --git a/Presence/Stanza/Types.hs b/Presence/Stanza/Types.hs
index cbb156a0..3e039a34 100644
--- a/Presence/Stanza/Types.hs
+++ b/Presence/Stanza/Types.hs
@@ -50,7 +50,20 @@ data StanzaType
                      , presencePriority :: Maybe Int8
                      , presenceStatus :: [(Lang,Text)]
                      , presenceWhiteList :: [Text]
+                        -- ^ A custom extension extension we are using.  When a
+                        -- peer answers a presence probe, it also communicates
+                        -- to the remote peer which remote users it believes
+                        -- are subscribed to that presence.
+                        --
+                        -- This is communicated via a space-delimited list in
+                        -- the nonstandard "whitelist" attribute for a
+                        -- <{jabber:server}presence> tag.
+                        --
+                        -- TODO: Use this to update the buddies file so that a
+                        -- client is made aware when a subscription was
+                        -- canceled.
                      }
+
     | PresenceInformError
     | PresenceInformSubscription Bool
     | PresenceRequestStatus