PlexDownloadQueueApi class

/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 setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

add({required String queueId, required List<String> keys}) → Future<void>

POST /downloadQueue/{queueId}/add?keys={ratingKeysJoinedByComma} — queue items for offline sync.

create() → Future<Map<String, dynamic>>

POST /downloadQueue — create a new download queue.

get(String queueId) → Future<Map<String, dynamic>>

GET /downloadQueue/{queueId} — fetch a queue's status.

item({required String queueId, required String itemId}) → Future<Map<String, dynamic>>

GET /downloadQueue/{queueId}/items/{itemId} — one queued item.

itemDecision({required String queueId, required String itemId}) → Future<Map<String, dynamic>>

GET /downloadQueue/{queueId}/item/{itemId}/decision — the decision document for a queued item (which media source, what transcode profile).

itemMedia({required String queueId, required String itemId}) → Future<Map<String, dynamic>>

GET /downloadQueue/{queueId}/item/{itemId}/media — the media payload (used by the mobile downloader to fetch bytes).

items(String queueId) → Future<Map<String, dynamic>>

GET /downloadQueue/{queueId}/items — every item in the queue.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

remove({required String queueId, required String itemId}) → Future<void>

DELETE /downloadQueue/{queueId}/items/{itemId} — remove an item from the queue.

restart({required String queueId, required String 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