mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 04:20:40 +00:00
27 lines
1.2 KiB
Plaintext
27 lines
1.2 KiB
Plaintext
---
|
|
id: activities
|
|
title: "Activities"
|
|
description: "Activities"
|
|
custom_edit_url: null
|
|
---
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
```mdx-code-block
|
|
import DocCardList from '@theme/DocCardList';
|
|
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
|
|
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
|
```
|
|
|