diff options
author | James Booth <boothj5@gmail.com> | 2017-01-18 22:46:29 +0000 |
---|---|---|
committer | James Booth <boothj5@gmail.com> | 2017-01-18 22:46:29 +0000 |
commit | fccf56be1059a2c254b9ed08fc385ee4e0513dee (patch) | |
tree | fd0a65c17b7a5e1186643c2f5a7b1aceab979998 /apidocs | |
parent | 70e831e08b803fe894296fc1f6b0f4157198a833 (diff) | |
download | profani-tty-fccf56be1059a2c254b9ed08fc385ee4e0513dee.tar.gz |
Add prof.encryption_reset to Plugins API
issue #885
Diffstat (limited to 'apidocs')
-rw-r--r-- | apidocs/c/profapi.h | 13 | ||||
-rw-r--r-- | apidocs/python/src/prof.py | 21 |
2 files changed, 34 insertions, 0 deletions
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h index 5a8a11cb..7d5cad0e 100644 --- a/apidocs/c/profapi.h +++ b/apidocs/c/profapi.h @@ -145,6 +145,13 @@ Retrieve nicknames of all occupants in a chat room, when in a chat room window. char** prof_get_current_occupants(void); /** +Retrieve current nickname used in chat room. +@param barejid The room's Jabber ID +@return Room nickname. +*/ +char* prof_get_room_nick(const char *barejid); + +/** Write to the Profanity log at level DEBUG. @param message The message to log */ @@ -326,3 +333,9 @@ If a session is already connected, a presence update will be sent to allow any c @param feature the service discovery feature to be added */ void prof_disco_add_feature(char *feature); + +/** +End any encrypted session with the specified user. +@param barejid Jabber ID of the recipient +*/ +void prof_encryption_reset(char *barejid); diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index 69d5aaea..22488f4b 100644 --- a/apidocs/python/src/prof.py +++ b/apidocs/python/src/prof.py @@ -262,6 +262,14 @@ def get_current_occupants(): pass +def get_room_nick(barejid): + """Retrieve current nickname used in chat room. + + :return: Room nickname. + :rtype: str + """ + + def current_win_is_console(): """Determine whether or not the Console window is currently focussed. @@ -597,6 +605,7 @@ def incoming_message(barejid, resource, message): prof.incoming_message("bob@server.org", "laptop", "Hello there") """ + def disco_add_feature(feature): """Add a service discovery feature the list supported by Profanity.\n If a session is already connected, a presence update will be sent to allow any client/server caches to update their feature list for Profanity @@ -609,3 +618,15 @@ def disco_add_feature(feature): prof.disco_add_feature("urn:xmpp:omemo:0:devicelist+notify") """ pass + + +def encryption_reset(barejid): + """End any encrypted session with the specified user + + :param barejid: Jabber ID of the recipient + :type barejid: str or unicode + + Example: + :: + prof.encryption_reset("alice@server.org") + """ |