Activities

(Activities)

Overview

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

GetServerActivities - Get Server Activities
CancelServerActivities - Cancel Server Activities

GetServerActivities

Get Server Activities

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Activities.GetServerActivitiesAsync();

// handle response

Response

GetServerActivitiesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetServerActivitiesBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetServerActivitiesUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/

CancelServerActivities

Cancel Server Activities

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Activities.CancelServerActivitiesAsync(activityUUID: "25b71ed5-0f9d-461c-baa7-d404e9e10d3e");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`ActivityUUID`	string	✔️	The UUID of the activity to cancel.	25b71ed5-0f9d-461c-baa7-d404e9e10d3e

Response

CancelServerActivitiesResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.CancelServerActivitiesBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.CancelServerActivitiesUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	/