Marius/JBOPS
1
0
Fork 0
mirror of https://github.com/blacktwin/JBOPS.git synced 2025-12-15 12:45:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add a docstring for terminate_session

Browse Source
This commit is contained in:
Landon Abney 2018-06-16 23:19:30 -07:00
parent 4ebfaf17bd
commit 0ba8e2bda0
No known key found for this signature in database
GPG Key ID: 15320D3C4A506996
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
killstream/kill_stream.py
View File

@ -144,7 +144,19 @@ def get_user_session_ids(user_id):
def terminate_session(session_id, message, notifier=None, username=None):
# Stop a streaming session.
"""Stop a streaming session.
Parameters
----------
session_id : str
The session ID of the stream to terminate.
message : str
The message to display to the user when terminating a stream.
notifier : int
Notification agent ID to send a message to (the default is None).
username : str
The username for the terminated session (the default is None).
"""
payload = {'apikey': TAUTULLI_APIKEY,
'cmd': 'terminate_session',
'session_id': session_id,