diff options
author | Michael Vetter <jubalh@iodoru.org> | 2021-07-01 09:41:07 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-01 09:41:07 +0200 |
commit | aae252e1b54c147bcf9404031e7862c0e955f571 (patch) | |
tree | 66844e760babe0b15f561b41165d1db8cb9d9ca6 /apidocs/python/src | |
parent | dc79c514be403cff93a1165b47d456182a03fd05 (diff) | |
parent | e4bf7335d889d82dedf962f2a2590f1a1b7455b6 (diff) | |
download | profani-tty-aae252e1b54c147bcf9404031e7862c0e955f571.tar.gz |
Merge pull request #1529 from dustinlagoy/access-roster-from-plugins
Access roster from plugins
Diffstat (limited to 'apidocs/python/src')
-rw-r--r-- | apidocs/python/src/prof.py | 18 |
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. |