Merge pull request #1529 from dustinlagoy/access-roster-from-plugins

Access roster from plugins

1 files changed, 18 insertions, 0 deletions

diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index 6c80e2f2..1b926b36 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -253,6 +253,24 @@ def get_current_nick():
     pass
 
 
+def get_name_from_roster(barejid):
+    """Retrieve a nickname from a barejid if it is in the roster.
+
+    :return: the users nickname e.g. "eddie", or the input barejid if it is not in the roster.
+    :rtype: str
+    """
+    pass
+
+
+def get_barejid_from_roster(name):
+    """Retrieve the barejid for a given nickname if it is in the roster.
+
+    :return: the users barejid e.g. "eddie@server.tld", or ``None`` if the nickname is not in the roster.
+    :rtype: str
+    """
+    pass
+
+
 def get_current_occupants(): 
     """Retrieve nicknames of all occupants in a chat room, when in a chat room window.