PlexDownloadQueueApi class Events and downloads

/downloadQueue/* — legacy mobile-sync download queue.

Wraps the Download Queue OpenAPI tag (9 operations). Plex's mobile apps historically used this surface to maintain an offline copy of media on the device. New clients should prefer the PlexStreamingApi / PlexPlayQueuesApi flow; this sub-API exists so older mobile workflows can still be driven from Dart.

Constructors

PlexDownloadQueueApi(PlexConnection _http)
Construct from a PlexConnection. Typically obtained via PlexClient.downloadQueue.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

add({required int queueId, required List<String> keys}) → Future<void>
POST /downloadQueue/{queueId}/add?keys={ratingKeysJoinedByComma} — queue items for offline sync.
create() → Future<PlexDownloadQueue>
POST /downloadQueue — this client's download queue, created when it has none (one per client and user; verified on PMS 1.43.2).
get({required int queueId}) → Future<PlexDownloadQueue?>
GET /downloadQueue/{queueId} — a queue's status, or null when the answer holds none.
item({required int queueId, required int itemId}) → Future<PlexDownloadQueueItem?>
GET /downloadQueue/{queueId}/items/{itemId} — one queued item, or null when the answer holds none.
itemDecision({required int queueId, required int itemId}) → Future<PlexTranscodeDecision>
GET /downloadQueue/{queueId}/item/{itemId}/decision — the decision for a queued item (which media source, what transcode profile); PlexTranscodeDecision.raw holds the item's metadata.
itemMediaUrl({required int queueId, required int itemId}) → String
GET /downloadQueue/{queueId}/item/{itemId}/media — the URL of the item's file, once it is available: the media itself, not JSON, so it is a URL to hand to downloadToFile or PlexClient.requestStream.
items({required int queueId}) → Future<List<PlexDownloadQueueItem>>
GET /downloadQueue/{queueId}/items — every item in the queue, with its status and decision.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
remove({required int queueId, required int itemId}) → Future<void>
DELETE /downloadQueue/{queueId}/items/{itemId} — remove an item from the queue.
restart({required int queueId, required int itemId}) → Future<void>
POST /downloadQueue/{queueId}/items/{itemId}/restart — re-run the decision step (re-evaluate which version of the item to grab).
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited