LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-09 20:47:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial Commit

Browse Source
This commit is contained in:
Luke Hagar
2024-01-01 15:47:37 -06:00
parent 203c48ae7c
commit f91c1e6f54
4519 changed files with 88021 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
content/pages/01-reference/python/resources/activities/activities.mdx Normal file
View File

@@ -0,0 +1,23 @@
import GetServerActivities from "./get_server_activities/get_server_activities.mdx";
import CancelServerActivities from "./cancel_server_activities/cancel_server_activities.mdx";
## Activities
Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real\-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
Activities are associated with HTTP replies via a special `X\-Plex\-Activity` header which contains the UUID of the activity.
Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details:
\- They can contain a `progress` (from 0 to 100) marking the percent completion of the activity.
\- They must contain an `type` which is used by clients to distinguish the specific activity.
\- They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
\- The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
### Available Operations
* [Get Server Activities](/python/activities/get_server_activities) - Get Server Activities
* [Cancel Server Activities](/python/activities/cancel_server_activities) - Cancel Server Activities
---
<GetServerActivities />
---
<CancelServerActivities />