Add plugin prof_get_nick_from_roster function

1 files changed, 9 insertions, 0 deletions

diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index 6c80e2f2..aeec3604 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -253,6 +253,15 @@ def get_current_nick():
     pass
 
 
+def get_nick_from_roster(barejid):
+    """Retrieve a nickname from a barejid if it is in the roster.
+
+    :return: the users nickname e.g. ``"eddie"``, or ``None`` if the barejid 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.