mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 04:20:46 +00:00
## Csharp SDK Changes Detected:
* `PlexApi.Butler.StartTask()`: * `request` **Changed** **Breaking** ⚠️ * `error` **Changed** **Breaking** ⚠️ * `PlexApi.Butler.StopTask()`: * `request` **Changed** **Breaking** ⚠️ * `error` **Changed** **Breaking** ⚠️ * `PlexApi.Updater.ApplyUpdates()`: * `request` **Changed** **Breaking** ⚠️ * `error` **Changed** **Breaking** ⚠️ * `PlexApi.General.GetServerInfo()`: **Added** * `PlexApi.General.GetIdentity()`: **Added** * `PlexApi.General.GetSourceConnectionInformation()`: **Added** * `PlexApi.General.GetTransientToken()`: **Added** * `PlexApi.Events.GetNotifications()`: **Added** * `PlexApi.Events.ConnectWebSocket()`: **Added** * `PlexApi.Preferences.GetAllPreferences()`: **Added** * `PlexApi.Preferences.SetPreferences()`: **Added** * `PlexApi.Preferences.GetPreference()`: **Added** * `PlexApi.Rate.SetRating()`: **Added** * `PlexApi.Timeline.MarkPlayed()`: **Added** * `PlexApi.Timeline.Report()`: **Added** * `PlexApi.Timeline.Unscrobble()`: **Added** * `PlexApi.Activities.ListActivities()`: **Added** * `PlexApi.Activities.CancelActivity()`: **Added** * `PlexApi.Butler.StopTasks()`: **Added** * `PlexApi.Butler.GetTasks()`: **Added** * `PlexApi.Butler.StartTasks()`: **Added** * `PlexApi.DownloadQueue.CreateDownloadQueue()`: **Added** * `PlexApi.DownloadQueue.GetDownloadQueue()`: **Added** * `PlexApi.DownloadQueue.AddDownloadQueueItems()`: **Added** * `PlexApi.DownloadQueue.ListDownloadQueueItems()`: **Added** * `PlexApi.DownloadQueue.GetItemDecision()`: **Added** * `PlexApi.DownloadQueue.GetDownloadQueueMedia()`: **Added** * `PlexApi.DownloadQueue.RemoveDownloadQueueItems()`: **Added** * `PlexApi.DownloadQueue.GetDownloadQueueItems()`: **Added** * `PlexApi.DownloadQueue.RestartProcessingDownloadQueueItems()`: **Added** * `PlexApi.Hubs.GetAllHubs()`: **Added** * `PlexApi.Hubs.GetContinueWatching()`: **Added** * `PlexApi.Hubs.GetHubItems()`: **Added** * `PlexApi.Hubs.GetPromotedHubs()`: **Added** * `PlexApi.Hubs.GetMetadataHubs()`: **Added** * `PlexApi.Hubs.GetPostplayHubs()`: **Added** * `PlexApi.Hubs.GetRelatedHubs()`: **Added** * `PlexApi.Hubs.GetSectionHubs()`: **Added** * `PlexApi.Hubs.ResetSectionDefaults()`: **Added** * `PlexApi.Hubs.ListHubs()`: **Added** * `PlexApi.Hubs.CreateCustomHub()`: **Added** * `PlexApi.Hubs.MoveHub()`: **Added** * `PlexApi.Hubs.DeleteCustomHub()`: **Added** * `PlexApi.Hubs.UpdateHubVisibility()`: **Added** * `PlexApi.Search.SearchHubs()`: **Added** * `PlexApi.Search.VoiceSearchHubs()`: **Added** * `PlexApi.Library.GetLibraryItems()`: **Added** * `PlexApi.Library.DeleteCaches()`: **Added** * `PlexApi.Library.CleanBundles()`: **Added** * `PlexApi.Library.IngestTransientItem()`: **Added** * `PlexApi.Library.GetLibraryMatches()`: **Added** * `PlexApi.Library.OptimizeDatabase()`: **Added** * `PlexApi.Library.GetRandomArtwork()`: **Added** * `PlexApi.Library.GetSections()`: **Added** * `PlexApi.Library.AddSection()`: **Added** * `PlexApi.Library.StopAllRefreshes()`: **Added** * `PlexApi.Library.GetSectionsPrefs()`: **Added** * `PlexApi.Library.RefreshSectionsMetadata()`: **Added** * `PlexApi.Library.GetTags()`: **Added** * `PlexApi.Library.DeleteMetadataItem()`: **Added** * `PlexApi.Library.EditMetadataItem()`: **Added** * `PlexApi.Library.DetectAds()`: **Added** * `PlexApi.Library.GetAllItemLeaves()`: **Added** * `PlexApi.Library.AnalyzeMetadata()`: **Added** * `PlexApi.Library.GenerateThumbs()`: **Added** * `PlexApi.Library.DetectCredits()`: **Added** * `PlexApi.Library.GetExtras()`: **Added** * `PlexApi.Library.AddExtras()`: **Added** * `PlexApi.Library.GetFile()`: **Added** * `PlexApi.Library.StartBifGeneration()`: **Added** * `PlexApi.Library.DetectIntros()`: **Added** * `PlexApi.Library.CreateMarker()`: **Added** * `PlexApi.Library.MatchItem()`: **Added** * `PlexApi.Library.ListMatches()`: **Added** * `PlexApi.Library.MergeItems()`: **Added** * `PlexApi.Library.ListSonicallySimilar()`: **Added** * `PlexApi.Library.SetItemPreferences()`: **Added** * `PlexApi.Library.RefreshItemsMetadata()`: **Added** * `PlexApi.Library.GetRelatedItems()`: **Added** * `PlexApi.Library.ListSimilar()`: **Added** * `PlexApi.Library.SplitItem()`: **Added** * `PlexApi.Library.AddSubtitles()`: **Added** * `PlexApi.Library.GetItemTree()`: **Added** * `PlexApi.Library.Unmatch()`: **Added** * `PlexApi.Library.ListTopUsers()`: **Added** * `PlexApi.Library.DetectVoiceActivity()`: **Added** * `PlexApi.Library.GetAugmentationStatus()`: **Added** * `PlexApi.Library.SetStreamSelection()`: **Added** * `PlexApi.Library.GetPerson()`: **Added** * `PlexApi.Library.ListPersonMedia()`: **Added** * `PlexApi.Library.DeleteLibrarySection()`: **Added** * `PlexApi.Library.GetLibraryDetails()`: **Added** * `PlexApi.Library.EditSection()`: **Added** * `PlexApi.Library.UpdateItems()`: **Added** * `PlexApi.Library.StartAnalysis()`: **Added** * `PlexApi.Library.Autocomplete()`: **Added** * `PlexApi.Library.GetCollections()`: **Added** * `PlexApi.Library.GetCommon()`: **Added** * `PlexApi.Library.EmptyTrash()`: **Added** * `PlexApi.Library.GetSectionFilters()`: **Added** * `PlexApi.Library.GetFirstCharacters()`: **Added** * `PlexApi.Library.DeleteIndexes()`: **Added** * `PlexApi.Library.DeleteIntros()`: **Added** * `PlexApi.Library.GetSectionPreferences()`: **Added** * `PlexApi.Library.SetSectionPreferences()`: **Added** * `PlexApi.Library.CancelRefresh()`: **Added** * `PlexApi.Library.RefreshSection()`: **Added** * `PlexApi.Library.GetAvailableSorts()`: **Added** * `PlexApi.Library.GetStreamLevels()`: **Added** * `PlexApi.Library.GetStreamLoudness()`: **Added** * `PlexApi.Library.GetChapterImage()`: **Added** * `PlexApi.Library.SetItemArtwork()`: **Added** * `PlexApi.Library.UpdateItemArtwork()`: **Added** * `PlexApi.Library.DeleteMarker()`: **Added** * `PlexApi.Library.EditMarker()`: **Added** * `PlexApi.Library.DeleteMediaItem()`: **Added** * `PlexApi.Library.GetPartIndex()`: **Added** * `PlexApi.Library.DeleteCollection()`: **Added** * `PlexApi.Library.GetSectionImage()`: **Added** * `PlexApi.Library.DeleteStream()`: **Added** * `PlexApi.Library.GetStream()`: **Added** * `PlexApi.Library.SetStreamOffset()`: **Added** * `PlexApi.Library.GetItemArtwork()`: **Added** * `PlexApi.Library.GetMediaPart()`: **Added** * `PlexApi.Library.GetImageFromBif()`: **Added** * `PlexApi.Collections.CreateCollection()`: **Added** * `PlexApi.DvRs.ListDvRs()`: **Added** * `PlexApi.DvRs.CreateDvr()`: **Added** * `PlexApi.DvRs.DeleteDvr()`: **Added** * `PlexApi.DvRs.GetDvr()`: **Added** * `PlexApi.DvRs.DeleteLineup()`: **Added** * `PlexApi.DvRs.AddLineup()`: **Added** * `PlexApi.DvRs.SetDvrPreferences()`: **Added** * `PlexApi.DvRs.StopDvrReload()`: **Added** * `PlexApi.DvRs.ReloadGuide()`: **Added** * `PlexApi.DvRs.TuneChannel()`: **Added** * `PlexApi.DvRs.RemoveDeviceFromDvr()`: **Added** * `PlexApi.DvRs.AddDeviceToDvr()`: **Added** * `PlexApi.Epg.ComputeChannelMap()`: **Added** * `PlexApi.Epg.GetChannels()`: **Added** * `PlexApi.Epg.GetCountries()`: **Added** * `PlexApi.Epg.GetAllLanguages()`: **Added** * `PlexApi.Epg.GetLineup()`: **Added** * `PlexApi.Epg.GetLineupChannels()`: **Added** * `PlexApi.Epg.GetCountriesLineups()`: **Added** * `PlexApi.Epg.GetCountryRegions()`: **Added** * `PlexApi.Epg.ListLineups()`: **Added** * `PlexApi.LiveTv.GetSessions()`: **Added** * `PlexApi.LiveTv.GetLiveTvSession()`: **Added** * `PlexApi.LiveTv.GetSessionPlaylistIndex()`: **Added** * `PlexApi.LiveTv.GetSessionSegment()`: **Added** * `PlexApi.Log.WriteLog()`: **Added** * `PlexApi.Log.WriteMessage()`: **Added** * `PlexApi.Log.EnablePapertrail()`: **Added** * `PlexApi.Devices.GetAvailableGrabbers()`: **Added** * `PlexApi.Devices.ListDevices()`: **Added** * `PlexApi.Devices.AddDevice()`: **Added** * `PlexApi.Devices.DiscoverDevices()`: **Added** * `PlexApi.Devices.RemoveDevice()`: **Added** * `PlexApi.Devices.GetDeviceDetails()`: **Added** * `PlexApi.Devices.ModifyDevice()`: **Added** * `PlexApi.Devices.SetChannelmap()`: **Added** * `PlexApi.Devices.GetDevicesChannels()`: **Added** * `PlexApi.Devices.SetDevicePreferences()`: **Added** * `PlexApi.Devices.StopScan()`: **Added** * `PlexApi.Devices.Scan()`: **Added** * `PlexApi.Devices.GetThumb()`: **Added** * `PlexApi.Provider.ListProviders()`: **Added** * `PlexApi.Provider.AddProvider()`: **Added** * `PlexApi.Provider.RefreshProviders()`: **Added** * `PlexApi.Provider.DeleteMediaProvider()`: **Added** * `PlexApi.Subscriptions.GetAllSubscriptions()`: **Added** * `PlexApi.Subscriptions.CreateSubscription()`: **Added** * `PlexApi.Subscriptions.ProcessSubscriptions()`: **Added** * `PlexApi.Subscriptions.GetScheduledRecordings()`: **Added** * `PlexApi.Subscriptions.GetTemplate()`: **Added** * `PlexApi.Subscriptions.CancelGrab()`: **Added** * `PlexApi.Subscriptions.DeleteSubscription()`: **Added** * `PlexApi.Subscriptions.GetSubscription()`: **Added** * `PlexApi.Subscriptions.EditSubscriptionPreferences()`: **Added** * `PlexApi.Subscriptions.ReorderSubscription()`: **Added** * `PlexApi.Transcoder.TranscodeImage()`: **Added** * `PlexApi.Transcoder.MakeDecision()`: **Added** * `PlexApi.Transcoder.TriggerFallback()`: **Added** * `PlexApi.Transcoder.TranscodeSubtitles()`: **Added** * `PlexApi.Transcoder.StartTranscodeSession()`: **Added** * `PlexApi.Playlist.ListPlaylists()`: **Added** * `PlexApi.Playlist.GetPlaylist()`: **Added** * `PlexApi.Playlist.GetPlaylistItems()`: **Added** * `PlexApi.LibraryPlaylists.CreatePlaylist()`: **Added** * `PlexApi.LibraryPlaylists.UploadPlaylist()`: **Added** * `PlexApi.LibraryPlaylists.DeletePlaylist()`: **Added** * `PlexApi.LibraryPlaylists.UpdatePlaylist()`: **Added** * `PlexApi.LibraryPlaylists.GetPlaylistGenerators()`: **Added** * `PlexApi.LibraryPlaylists.ClearPlaylistItems()`: **Added** * `PlexApi.LibraryPlaylists.AddPlaylistItems()`: **Added** * `PlexApi.LibraryPlaylists.DeletePlaylistItem()`: **Added** * `PlexApi.LibraryPlaylists.GetPlaylistGenerator()`: **Added** * `PlexApi.LibraryPlaylists.GetPlaylistGeneratorItems()`: **Added** * `PlexApi.LibraryPlaylists.MovePlaylistItem()`: **Added** * `PlexApi.LibraryPlaylists.RefreshPlaylist()`: **Added** * `PlexApi.PlayQueue.CreatePlayQueue()`: **Added** * `PlexApi.PlayQueue.GetPlayQueue()`: **Added** * `PlexApi.PlayQueue.AddToPlayQueue()`: **Added** * `PlexApi.PlayQueue.ClearPlayQueue()`: **Added** * `PlexApi.PlayQueue.ResetPlayQueue()`: **Added** * `PlexApi.PlayQueue.Shuffle()`: **Added** * `PlexApi.PlayQueue.Unshuffle()`: **Added** * `PlexApi.PlayQueue.DeletePlayQueueItem()`: **Added** * `PlexApi.PlayQueue.MovePlayQueueItem()`: **Added** * `PlexApi.UltraBlur.GetColors()`: **Added** * `PlexApi.UltraBlur.GetImage()`: **Added** * `PlexApi.Status.ListSessions()`: **Added** * `PlexApi.Status.GetBackgroundTasks()`: **Added** * `PlexApi.Status.ListPlaybackHistory()`: **Added** * `PlexApi.Status.TerminateSession()`: **Added** * `PlexApi.Status.DeleteHistory()`: **Added** * `PlexApi.Status.GetHistoryItem()`: **Added** * `PlexApi.Updater.CheckUpdates()`: **Added** * `PlexApi.Updater.GetUpdatesStatus()`: **Added** * `PlexApi.Content.GetCollectionItems()`: **Added** * `PlexApi.Content.GetMetadataItem()`: **Added** * `PlexApi.Content.GetAlbums()`: **Added** * `PlexApi.Content.ListContent()`: **Added** * `PlexApi.Content.GetAllLeaves()`: **Added** * `PlexApi.Content.GetArts()`: **Added** * `PlexApi.Content.GetCategories()`: **Added** * `PlexApi.Content.GetCluster()`: **Added** * `PlexApi.Content.GetSonicPath()`: **Added** * `PlexApi.Content.GetFolders()`: **Added** * `PlexApi.Content.ListMoments()`: **Added** * `PlexApi.Content.GetSonicallySimilar()`: **Added** * `PlexApi.Content.GetCollectionImage()`: **Added** * `PlexApi.LibraryCollections.AddCollectionItems()`: **Added** * `PlexApi.LibraryCollections.DeleteCollectionItem()`: **Added** * `PlexApi.LibraryCollections.MoveCollectionItem()`: **Added** * `PlexApi.Server.GetServerCapabilities()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetServerPreferences()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetAvailableClients()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetDevices()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.Get-Server-Identity()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetMyPlexAccount()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetResizedPhoto()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.Get-Media-Providers()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Server.GetServerList()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Media.MarkPlayed()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Media.MarkUnplayed()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Media.UpdatePlayProgress()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Media.Get-Banner-Image()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Media.Get-Thumb-Image()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Video.GetTimeline()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Video.StartUniversalTranscode()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Activities.GetServerActivities()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Activities.CancelServerActivities()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Butler.GetButlerTasks()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Butler.StartAllTasks()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Butler.StopAllTasks()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetCompanionsData()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetUserFriends()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetGeoData()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetHomeData()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.Get-Server-Resources()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetPin()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Plex.GetTokenByPinId()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Hubs.GetGlobalHubs()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Hubs.Get-Recently-Added()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Hubs.GetLibraryHubs()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Search.PerformSearch()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Search.PerformVoiceSearch()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Search.GetSearchResults()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.GetFileHash()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Recently-Added-Library()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-All-Libraries()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Library-Details()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.DeleteLibrary()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Library-Items()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Library-Sections-All()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Refresh-Library-Metadata()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Search-Library()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Genres-Library()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Countries-Library()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Actors-Library()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Search-All-Libraries()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Media-Meta-Data()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Media-Arts()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Post-Media-Arts()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Get-Media-Posters()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.Post-Media-Poster()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.GetMetadataChildren()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Library.GetTopWatchedContent()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Watchlist.Get-Watch-List()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Log.LogLine()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Log.LogMultiLine()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Log.EnablePaperTrail()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.CreatePlaylist()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.GetPlaylists()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.GetPlaylist()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.DeletePlaylist()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.UpdatePlaylist()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.GetPlaylistContents()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.ClearPlaylistContents()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.AddPlaylistContents()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Playlists.UploadPlaylist()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Authentication.GetTransientToken()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Authentication.GetSourceConnectionInformation()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Authentication.GetTokenDetails()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Authentication.Post-Users-Sign-In-Data()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Statistics.GetStatistics()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Statistics.GetResourcesStatistics()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Statistics.GetBandwidthStatistics()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Sessions.GetSessions()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Sessions.GetSessionHistory()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Sessions.GetTranscodeSessions()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Sessions.StopTranscodeSession()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Updater.GetUpdateStatus()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Updater.CheckForUpdates()`: **Deleted** **Breaking** ⚠️ * `PlexApi.Users.Get-Users()`: **Deleted** **Breaking** ⚠️
This commit is contained in:
speakeasybot
505
NUGET.md
505
NUGET.md
@@ -9,10 +9,56 @@
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
|
||||
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
|
||||
var sdk = new PlexAPI(
|
||||
accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
token: "<YOUR_API_KEY_HERE>"
|
||||
);
|
||||
|
||||
var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
StartTranscodeSessionRequest req = new StartTranscodeSessionRequest() {
|
||||
TranscodeType = TranscodeType.Music,
|
||||
Extension = Extension.Mpd,
|
||||
AdvancedSubtitles = LukeHagar.PlexAPI.SDK.Models.Components.AdvancedSubtitles.Burn,
|
||||
AudioBoost = 50,
|
||||
AudioChannelCount = 5,
|
||||
AutoAdjustQuality = BoolInt.One,
|
||||
AutoAdjustSubtitle = BoolInt.One,
|
||||
DirectPlay = BoolInt.One,
|
||||
DirectStream = BoolInt.One,
|
||||
DirectStreamAudio = BoolInt.One,
|
||||
DisableResolutionRotation = BoolInt.One,
|
||||
HasMDE = BoolInt.One,
|
||||
Location = StartTranscodeSessionQueryParamLocation.Wan,
|
||||
MediaBufferSize = 102400,
|
||||
MediaIndex = 0,
|
||||
MusicBitrate = 5000,
|
||||
Offset = 90.5D,
|
||||
PartIndex = 0,
|
||||
Path = "/library/metadata/151671",
|
||||
PeakBitrate = 12000,
|
||||
PhotoResolution = "1080x1080",
|
||||
Protocol = StartTranscodeSessionQueryParamProtocol.Dash,
|
||||
SecondsPerSegment = 5,
|
||||
SubtitleSize = 50,
|
||||
VideoBitrate = 12000,
|
||||
VideoQuality = 50,
|
||||
VideoResolution = "1080x1080",
|
||||
XPlexClientProfileExtra = "add-limitation(scope=videoCodec&scopeName=*&type=upperBound&name=video.frameRate&value=60&replace=true)+append-transcode-target-codec(type=videoProfile&context=streaming&videoCodec=h264%2Chevc&audioCodec=aac&protocol=dash)",
|
||||
XPlexClientProfileName = "generic",
|
||||
};
|
||||
|
||||
var res = await sdk.Transcoder.StartTranscodeSessionAsync(req);
|
||||
|
||||
// handle response
|
||||
```
|
||||
@@ -25,18 +71,34 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme |
|
||||
| ------------- | ------ | ------- |
|
||||
| `AccessToken` | apiKey | API key |
|
||||
| Name | Type | Scheme |
|
||||
| ------- | ------ | ------- |
|
||||
| `Token` | apiKey | API key |
|
||||
|
||||
To authenticate with the API the `AccessToken` parameter must be set when initializing the SDK client instance. For example:
|
||||
To authenticate with the API the `Token` parameter must be set when initializing the SDK client instance. For example:
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
|
||||
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
|
||||
var sdk = new PlexAPI(
|
||||
token: "<YOUR_API_KEY_HERE>",
|
||||
accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay"
|
||||
);
|
||||
|
||||
var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
GetServerInfoRequest req = new GetServerInfoRequest() {};
|
||||
|
||||
var res = await sdk.General.GetServerInfoAsync(req);
|
||||
|
||||
// handle response
|
||||
```
|
||||
@@ -56,21 +118,34 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
| `RawResponse` | *HttpResponseMessage* | HTTP response object |
|
||||
| `Body` | *string* | HTTP response body |
|
||||
|
||||
Some exceptions in this SDK include an additional `Payload` field, which will contain deserialized custom error data when present. Possible exceptions are listed in the [Error Classes](#error-classes) section.
|
||||
|
||||
### Example
|
||||
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Errors;
|
||||
using System.Collections.Generic;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
|
||||
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
|
||||
var sdk = new PlexAPI(
|
||||
accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
token: "<YOUR_API_KEY_HERE>"
|
||||
);
|
||||
|
||||
try
|
||||
{
|
||||
var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
GetServerInfoRequest req = new GetServerInfoRequest() {};
|
||||
|
||||
var res = await sdk.General.GetServerInfoAsync(req);
|
||||
|
||||
// handle response
|
||||
}
|
||||
@@ -85,20 +160,6 @@ catch (PlexAPIError ex) // all SDK exceptions inherit from PlexAPIError
|
||||
int statusCode = ex.StatusCode;
|
||||
string? contentType = ex.ContentType;
|
||||
var responseBody = ex.Body;
|
||||
|
||||
if (ex is GetServerCapabilitiesBadRequest) // different exceptions may be thrown depending on the method
|
||||
{
|
||||
// Check error data fields
|
||||
GetServerCapabilitiesBadRequestPayload payload = ex.Payload;
|
||||
List<Errors> Errors = payload.Errors;
|
||||
HttpResponseMessage RawResponse = payload.RawResponse;
|
||||
}
|
||||
|
||||
// An underlying cause may be provided
|
||||
if (ex.InnerException != null)
|
||||
{
|
||||
Exception cause = ex.InnerException;
|
||||
}
|
||||
}
|
||||
catch (System.Net.Http.HttpRequestException ex)
|
||||
{
|
||||
@@ -111,234 +172,248 @@ catch (System.Net.Http.HttpRequestException ex)
|
||||
**Primary exception:**
|
||||
* [`PlexAPIError`](./LukeHagar/PlexAPI/SDK/Models/Errors/PlexAPIError.cs): The base class for HTTP error responses.
|
||||
|
||||
<details><summary>Less common exceptions (158)</summary>
|
||||
<details><summary>Less common exceptions (2)</summary>
|
||||
|
||||
* [`System.Net.Http.HttpRequestException`](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httprequestexception): Network connectivity error. For more details about the underlying cause, inspect the `ex.InnerException`.
|
||||
|
||||
* Inheriting from [`PlexAPIError`](./LukeHagar/PlexAPI/SDK/Models/Errors/PlexAPIError.cs):
|
||||
* [`GetServerCapabilitiesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerCapabilitiesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerPreferencesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerPreferencesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAvailableClientsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetAvailableClientsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetDevicesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetDevicesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMyPlexAccountBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMyPlexAccountBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResizedPhotoBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetResizedPhotoBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaProvidersBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMediaProvidersBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerListBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerListBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkPlayedBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/MarkPlayedBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkUnplayedBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/MarkUnplayedBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlayProgressBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/UpdatePlayProgressBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBannerImageBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetBannerImageBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetThumbImageBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetThumbImageBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTimelineBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTimelineBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartUniversalTranscodeBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartUniversalTranscodeBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerActivitiesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerActivitiesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CancelServerActivitiesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/CancelServerActivitiesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetButlerTasksBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetButlerTasksBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartAllTasksBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartAllTasksBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopAllTasksBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopAllTasksBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StartTaskBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartTaskBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTaskBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopTaskBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCompanionsDataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetCompanionsDataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUserFriendsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUserFriendsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGeoDataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGeoDataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetHomeDataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetHomeDataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerResourcesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerResourcesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPinBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPinBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenByPinIdBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTokenByPinIdBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGlobalHubsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGlobalHubsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryHubsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryHubsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformSearchBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/PerformSearchBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformVoiceSearchBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/PerformVoiceSearchBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchResultsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchResultsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetFileHashBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetFileHashBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRecentlyAddedLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetRecentlyAddedLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAllLibrariesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetAllLibrariesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryDetailsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryDetailsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`DeleteLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/DeleteLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryItemsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryItemsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibrarySectionsAllBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibrarySectionsAllBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRefreshLibraryMetadataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetRefreshLibraryMetadataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGenresLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGenresLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCountriesLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetCountriesLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetActorsLibraryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetActorsLibraryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchAllLibrariesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchAllLibrariesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaMetaDataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMediaMetaDataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMetadataChildrenBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMetadataChildrenBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTopWatchedContentBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTopWatchedContentBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetWatchListBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetWatchListBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`LogLineBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/LogLineBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`LogMultiLineBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/LogMultiLineBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`EnablePaperTrailBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/EnablePaperTrailBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CreatePlaylistBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/CreatePlaylistBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`DeletePlaylistBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/DeletePlaylistBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlaylistBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/UpdatePlaylistBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistContentsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistContentsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`ClearPlaylistContentsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/ClearPlaylistContentsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`AddPlaylistContentsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/AddPlaylistContentsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`UploadPlaylistBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/UploadPlaylistBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTransientTokenBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTransientTokenBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSourceConnectionInformationBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSourceConnectionInformationBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenDetailsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTokenDetailsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`PostUsersSignInDataBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/PostUsersSignInDataBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetStatisticsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetStatisticsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResourcesStatisticsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetResourcesStatisticsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBandwidthStatisticsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetBandwidthStatisticsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSessionsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionHistoryBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSessionHistoryBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTranscodeSessionsBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTranscodeSessionsBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTranscodeSessionBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopTranscodeSessionBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUpdateStatusBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUpdateStatusBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`CheckForUpdatesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/CheckForUpdatesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`ApplyUpdatesBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/ApplyUpdatesBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUsersBadRequest`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUsersBadRequest.cs): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerCapabilitiesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerCapabilitiesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerPreferencesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerPreferencesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAvailableClientsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetAvailableClientsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetDevicesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetDevicesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMyPlexAccountUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMyPlexAccountUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResizedPhotoUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetResizedPhotoUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaProvidersUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMediaProvidersUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerListUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerListUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkPlayedUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/MarkPlayedUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`MarkUnplayedUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/MarkUnplayedUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlayProgressUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/UpdatePlayProgressUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBannerImageUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetBannerImageUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetThumbImageUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetThumbImageUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTimelineUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTimelineUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartUniversalTranscodeUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartUniversalTranscodeUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerActivitiesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerActivitiesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CancelServerActivitiesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/CancelServerActivitiesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetButlerTasksUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetButlerTasksUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartAllTasksUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartAllTasksUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopAllTasksUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopAllTasksUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StartTaskUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StartTaskUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTaskUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopTaskUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCompanionsDataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetCompanionsDataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUserFriendsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUserFriendsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGeoDataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGeoDataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetHomeDataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetHomeDataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerResourcesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerResourcesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGlobalHubsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGlobalHubsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryHubsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryHubsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformSearchUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/PerformSearchUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PerformVoiceSearchUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/PerformVoiceSearchUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchResultsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchResultsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetFileHashUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetFileHashUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRecentlyAddedLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetRecentlyAddedLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetAllLibrariesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetAllLibrariesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryDetailsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryDetailsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`DeleteLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/DeleteLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibraryItemsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibraryItemsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetLibrarySectionsAllUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetLibrarySectionsAllUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetRefreshLibraryMetadataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetRefreshLibraryMetadataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetGenresLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetGenresLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetCountriesLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetCountriesLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetActorsLibraryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetActorsLibraryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSearchAllLibrariesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSearchAllLibrariesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMediaMetaDataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMediaMetaDataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetMetadataChildrenUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetMetadataChildrenUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTopWatchedContentUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTopWatchedContentUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetWatchListUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetWatchListUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`LogLineUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/LogLineUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`LogMultiLineUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/LogMultiLineUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`EnablePaperTrailUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/EnablePaperTrailUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CreatePlaylistUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/CreatePlaylistUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`DeletePlaylistUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/DeletePlaylistUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UpdatePlaylistUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/UpdatePlaylistUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetPlaylistContentsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetPlaylistContentsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`ClearPlaylistContentsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/ClearPlaylistContentsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`AddPlaylistContentsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/AddPlaylistContentsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`UploadPlaylistUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/UploadPlaylistUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTransientTokenUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTransientTokenUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSourceConnectionInformationUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSourceConnectionInformationUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenDetailsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTokenDetailsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`PostUsersSignInDataUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/PostUsersSignInDataUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetStatisticsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetStatisticsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetResourcesStatisticsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetResourcesStatisticsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetBandwidthStatisticsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetBandwidthStatisticsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSessionsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetSessionHistoryUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetSessionHistoryUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTranscodeSessionsUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTranscodeSessionsUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`StopTranscodeSessionUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/StopTranscodeSessionUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUpdateStatusUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUpdateStatusUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`CheckForUpdatesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/CheckForUpdatesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`ApplyUpdatesUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/ApplyUpdatesUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetUsersUnauthorized`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetUsersUnauthorized.cs): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||
* [`GetTokenByPinIdResponseBody`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetTokenByPinIdResponseBody.cs): Not Found or Expired. Status code `404`. Applicable to 1 of 84 methods.*
|
||||
* [`GetServerIdentityRequestTimeout`](./LukeHagar/PlexAPI/SDK/Models/Errors/GetServerIdentityRequestTimeout.cs): Request Timeout. Status code `408`. Applicable to 1 of 84 methods.*
|
||||
* [`ResponseValidationError`](./LukeHagar/PlexAPI/SDK/Models/Errors/ResponseValidationError.cs): Thrown when the response data could not be deserialized into the expected type.
|
||||
</details>
|
||||
|
||||
\* Refer to the [relevant documentation](#available-resources-and-operations) to determine whether an exception applies to a specific operation.
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Server Variables
|
||||
### Select Server by Index
|
||||
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
You can override the default server globally by passing a server index to the `serverIndex: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
|
||||
| Variable | Parameter | Supported Values | Default | Description |
|
||||
| ---------- | ------------------------------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||
| `protocol` | `protocol: LukeHagar.PlexAPI.SDK.Models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
|
||||
| # | Server | Variables | Description |
|
||||
| --- | ---------------------------------------------------------- | -------------------------------------------- | ----------- |
|
||||
| 0 | `https://{IP-description}.{identifier}.plex.direct:{port}` | `identifier`<br/>`IP-description`<br/>`port` | |
|
||||
| 1 | `{protocol}://{host}:{port}` | `protocol`<br/>`host`<br/>`port` | |
|
||||
| 2 | `https://{full_server_url}` | `full_server_url` | |
|
||||
|
||||
If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
|
||||
|
||||
| Variable | Parameter | Default | Description |
|
||||
| ----------------- | ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `identifier` | `identifier: string` | `"0123456789abcdef0123456789abcdef"` | The unique identifier of this particular PMS |
|
||||
| `IP-description` | `ipDescription: string` | `"1-2-3-4"` | A `-` separated string of the IPv4 or IPv6 address components |
|
||||
| `port` | `port: string` | `"32400"` | The Port number configured on the PMS. Typically (`32400`). <br/>If using a reverse proxy, this would be the port number configured on the proxy.<br/> |
|
||||
| `protocol` | `protocol: string` | `"http"` | The network protocol to use. Typically (`http` or `https`) |
|
||||
| `host` | `host: string` | `"localhost"` | The Host of the PMS.<br/>If using on a local network, this is the internal IP address of the server hosting the PMS.<br/>If using on an external network, this is the external IP address for your network, and requires port forwarding.<br/>If using a reverse proxy, this would be the external DNS domain for your network, and requires the proxy handle port forwarding. <br/> |
|
||||
| `full_server_url` | `fullServerUrl: string` | `"http://localhost:32400"` | The full manual URL to access the PMS |
|
||||
|
||||
#### Example
|
||||
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
|
||||
var sdk = new PlexAPI(
|
||||
protocol: "https",
|
||||
ip: "4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d",
|
||||
port: "44765",
|
||||
accessToken: "<YOUR_API_KEY_HERE>"
|
||||
serverIndex: 1,
|
||||
protocol: "<value>",
|
||||
host: "electric-excess.name",
|
||||
port: "36393",
|
||||
accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
token: "<YOUR_API_KEY_HERE>"
|
||||
);
|
||||
|
||||
var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
GetServerInfoRequest req = new GetServerInfoRequest() {};
|
||||
|
||||
var res = await sdk.General.GetServerInfoAsync(req);
|
||||
|
||||
// handle response
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can also be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example:
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
|
||||
var sdk = new PlexAPI(
|
||||
serverUrl: "https://10.10.10.47:32400",
|
||||
accessToken: "<YOUR_API_KEY_HERE>"
|
||||
serverUrl: "https://http://localhost:32400",
|
||||
accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
|
||||
clientIdentifier: "abc123",
|
||||
product: "Plex for Roku",
|
||||
version: "2.4.1",
|
||||
platform: "Roku",
|
||||
platformVersion: "4.3 build 1057",
|
||||
device: "Roku 3",
|
||||
model: "4200X",
|
||||
deviceVendor: "Roku",
|
||||
deviceName: "Living Room TV",
|
||||
marketplace: "googlePlay",
|
||||
token: "<YOUR_API_KEY_HERE>"
|
||||
);
|
||||
|
||||
var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
GetServerInfoRequest req = new GetServerInfoRequest() {};
|
||||
|
||||
// handle response
|
||||
```
|
||||
|
||||
### Override Server URL Per-Operation
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
|
||||
var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");
|
||||
|
||||
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2");
|
||||
var res = await sdk.General.GetServerInfoAsync(req);
|
||||
|
||||
// handle response
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The C# SDK makes API calls using an `ISpeakeasyHttpClient` that wraps the native
|
||||
[HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient). This
|
||||
client provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle
|
||||
errors and response.
|
||||
|
||||
The `ISpeakeasyHttpClient` interface allows you to either use the default `SpeakeasyHttpClient` that comes with the SDK,
|
||||
or provide your own custom implementation with customized configuration such as custom message handlers, timeouts,
|
||||
connection pooling, and other HTTP client settings.
|
||||
|
||||
The following example shows how to create a custom HTTP client with request modification and error handling:
|
||||
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK;
|
||||
using LukeHagar.PlexAPI.SDK.Utils;
|
||||
using System.Net.Http;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
// Create a custom HTTP client
|
||||
public class CustomHttpClient : ISpeakeasyHttpClient
|
||||
{
|
||||
private readonly ISpeakeasyHttpClient _defaultClient;
|
||||
|
||||
public CustomHttpClient()
|
||||
{
|
||||
_defaultClient = new SpeakeasyHttpClient();
|
||||
}
|
||||
|
||||
public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)
|
||||
{
|
||||
// Add custom header and timeout
|
||||
request.Headers.Add("x-custom-header", "custom value");
|
||||
request.Headers.Add("x-request-timeout", "30");
|
||||
|
||||
try
|
||||
{
|
||||
var response = await _defaultClient.SendAsync(request, cancellationToken);
|
||||
// Log successful response
|
||||
Console.WriteLine($"Request successful: {response.StatusCode}");
|
||||
return response;
|
||||
}
|
||||
catch (Exception error)
|
||||
{
|
||||
// Log error
|
||||
Console.WriteLine($"Request failed: {error.Message}");
|
||||
throw;
|
||||
}
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
_httpClient?.Dispose();
|
||||
_defaultClient?.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
// Use the custom HTTP client with the SDK
|
||||
var customHttpClient = new CustomHttpClient();
|
||||
var sdk = new PlexAPI(client: customHttpClient);
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>You can also provide a completely custom HTTP client with your own configuration:</summary>
|
||||
|
||||
```csharp
|
||||
using LukeHagar.PlexAPI.SDK.Utils;
|
||||
using System.Net.Http;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
// Custom HTTP client with custom configuration
|
||||
public class AdvancedHttpClient : ISpeakeasyHttpClient
|
||||
{
|
||||
private readonly HttpClient _httpClient;
|
||||
|
||||
public AdvancedHttpClient()
|
||||
{
|
||||
var handler = new HttpClientHandler()
|
||||
{
|
||||
MaxConnectionsPerServer = 10,
|
||||
// ServerCertificateCustomValidationCallback = customCertValidation, // Custom SSL validation if needed
|
||||
};
|
||||
|
||||
_httpClient = new HttpClient(handler)
|
||||
{
|
||||
Timeout = TimeSpan.FromSeconds(30)
|
||||
};
|
||||
}
|
||||
|
||||
public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)
|
||||
{
|
||||
return await _httpClient.SendAsync(request, cancellationToken ?? CancellationToken.None);
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
_httpClient?.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
var sdk = PlexAPI.Builder()
|
||||
.WithClient(new AdvancedHttpClient())
|
||||
.Build();
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>For simple debugging, you can enable request/response logging by implementing a custom client:</summary>
|
||||
|
||||
```csharp
|
||||
public class LoggingHttpClient : ISpeakeasyHttpClient
|
||||
{
|
||||
private readonly ISpeakeasyHttpClient _innerClient;
|
||||
|
||||
public LoggingHttpClient(ISpeakeasyHttpClient innerClient = null)
|
||||
{
|
||||
_innerClient = innerClient ?? new SpeakeasyHttpClient();
|
||||
}
|
||||
|
||||
public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)
|
||||
{
|
||||
// Log request
|
||||
Console.WriteLine($"Sending {request.Method} request to {request.RequestUri}");
|
||||
|
||||
var response = await _innerClient.SendAsync(request, cancellationToken);
|
||||
|
||||
// Log response
|
||||
Console.WriteLine($"Received {response.StatusCode} response");
|
||||
|
||||
return response;
|
||||
}
|
||||
|
||||
public void Dispose() => _innerClient?.Dispose();
|
||||
}
|
||||
|
||||
var sdk = new PlexAPI(client: new LoggingHttpClient());
|
||||
```
|
||||
</details>
|
||||
|
||||
The SDK also provides built-in hook support through the `SDKConfiguration.Hooks` system, which automatically handles
|
||||
`BeforeRequestAsync`, `AfterSuccessAsync`, and `AfterErrorAsync` hooks for advanced request lifecycle management.
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
Reference in New Issue
Block a user