Articles

MyPlex plexapi.myplex Securities

by admin

class plexapi.myplex.MyPlexAccount(användarnamn=ingen, lösenord=ingen, token=ingen, session=ingen, timeout=ingen)

baser: plexapi.base.PlexObject

MyPlex konto-och profilinformation. Detta objekt representerar det data som hittades konto på myplex.tv servrar på webbadressen https://plex.tv/users/account. Du kan skapa detta objektdirekt genom att ange ditt användarnamn & lösenord (eller token). Det finns också en bekvämlighetmetod som tillhandahålls på myPlexAccount() som kommer att Skapaoch returnera detta objekt.

parametrar

  • användarnamn (str) – ditt myplex-användarnamn.

  • lösenord (str) – ditt myplex-lösenord.

  • session (förfrågningar.Session, valfritt) – Använd ditt eget sessionsobjekt om du villcache http – svaren från PMS

  • timeout (int) – timeout i sekunder vid första anslutningen till myplex (standardkonfiguration.TIMEOUT).

variabler

  • SIGNIN (str) – ’https://plex.tv/users/sign_in.xml’

  • nyckel (str) – ’https://plex.tv/users/account’

  • authenticationToken (str) – okänd.

  • certificateVersion (str) – okänd.

  • cloudSyncDevice (str) – okänd.

  • e-post (str) – din nuvarande Plex-e-postadress.

  • rättigheter (lista<str>) – lista över enheter som du får använda med det här kontot.

  • gäst (bool) – okänd.

  • hem (bool) – okänd.

  • homeSize (int) – okänd.

  • id (int) – ditt Plex-konto-ID.

  • locale (str) – din Plex locale

  • mailing_list_status (str) – din nuvarande e-postlista status.

  • maxHomeSize (int) – okänd.

  • queueEmail (str) – e-postadress för att lägga till objekt i din klocka senare kö.

  • queueUid (str) – okänd.

  • begränsad (bool) – okänd.

  • Roller – (lista<str>) upplyst av kontoroller. Plexpass-medlemskap listas här.

  • scrobbleTypes (str) – beskrivning

  • secure (bool) – beskrivning

  • subscriptionActive (bool) – True om din subsctiption är aktiv.

  • subscriptionFeatures – (lista<str>) lista över funktioner som är tillåtna på din prenumeration.

  • subscriptionPlan (str) – namn på prenumerationsplan.

  • subscriptionStatus (str) – Strängrepresentation av subscriptionActive.

  • thumb (str) – webbadressen till ditt konto miniatyrbild.

  • Titel (str) – okänd. – Ser ut som ett alias för användarnamn.

  • användarnamn (str) – ditt konto Användarnamn.

  • uuid (str) – okänd.

  • _token (str) – Token som används för att komma åt den här klienten.

  • _session (obj) – begär sessionsobjekt som används för att komma åt den här klienten.

device(name=None, clientId=None)

returnerarMyPlexDevice som matchar det angivna namnet.

parametrar

  • namn (str) – namn att matcha mot.

  • clientId (str) – clientIdentifier att matcha mot.

devices() bisexuell

returnerar en lista över allaMyPlexDevice objekt som är anslutna till servern.

resource(name) 2b

returnerarMyPlexResource som matchar det angivna namnet.

parametrar

namn (str) – namn att matcha mot.

resources() bisexuell

returnerar en lista över allaMyPlexResource objekt som är anslutna till servern.

inviteFriend(användare, server, sektioner=None, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=None, filterTelevision=None, filterMusic=None)

dela biblioteksinnehåll med den angivna användaren.

parametrar

  • användare (MyPlexUser) – myplexuser-objekt, användarnamn eller e-postav användaren som ska läggas till.

  • server (PlexServer) – PlexServer object, eller machineIdentifiercontaining bibliotekssektionerna att dela.

  • sektioner (lista<LibrarySection>) – lista över LibrarySection objecs, eller namnatt delas (Standard Ingen). sektioner måste definieras för att uppdatera delade bibliotek.

  • allowSync (Bool) – Ställ in True för att tillåta användare att synkronisera innehåll.

  • allowCameraUpload (Bool) – Ställ in True för att tillåta användare att ladda upp foton.

  • allowChannels (Bool) – Ställ in True för att tillåta användare att använda installerade kanaler.

  • filterMovies (Dict) – Dict innehåller nyckel ’contentRating’ och / eller ’label’ varje uppsättning till en lista ofvalues som ska filtreras. ex: {’contentRating’:,’label’:}

  • filterTelevision (Dict) – dict som innehåller nyckel’ contentRating ’och/eller’ label ’ varje uppsättning till en lista övervärden som ska filtreras. ex: {’contentRating’:, ’label’:}

  • filterMusic (Dict) – dict som innehåller nyckel ’label’ inställd på en lista med värden som ska filtreras.ex: {’etikett’:}

createHomeUser(användare, server, sektioner=None, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=None, filterTelevision=None, filterMusic=None)

dela biblioteksinnehåll med den angivna användaren.

parametrar

  • användare (MyPlexUser) – myplexuser-objekt, användarnamn eller e-postav användaren som ska läggas till.

  • server (PlexServer) – PlexServer object, eller machineIdentifiercontaining bibliotekssektionerna att dela.

  • sektioner (lista<LibrarySection>) – lista över LibrarySection objecs, eller namnatt delas (Standard Ingen). sektioner måste definieras för att uppdatera delade bibliotek.

  • allowSync (Bool) – Ställ in True för att tillåta användare att synkronisera innehåll.

  • allowCameraUpload (Bool) – Ställ in True för att tillåta användare att ladda upp foton.

  • allowChannels (Bool) – Ställ in True för att tillåta användare att använda installerade kanaler.

  • filterMovies (Dict) – Dict innehåller nyckel ’contentRating’ och / eller ’label’ varje uppsättning till en lista ofvalues som ska filtreras. ex: {’contentRating’:,’label’:}

  • filterTelevision (Dict) – dict som innehåller nyckel’ contentRating ’och/eller’ label ’ varje uppsättning till en lista övervärden som ska filtreras. ex: {’contentRating’:, ’label’:}

  • filterMusic (Dict) – dict som innehåller nyckel ’label’ inställd på en lista med värden som ska filtreras.ex: {’etikett’:}

createExistingUser(användare, server, sektioner=None, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=None, filterTelevision=None, filterMusic=None)

dela biblioteksinnehåll med den angivna användaren.

parametrar

  • användare (MyPlexUser) – myplexuser-objekt, användarnamn eller e-postav användaren som ska läggas till.

  • server (PlexServer) – PlexServer object, eller machineIdentifiercontaining bibliotekssektionerna att dela.

  • sektioner (lista<LibrarySection>) – lista över LibrarySection objecs, eller namnatt delas (Standard Ingen). sektioner måste definieras för att uppdatera delade bibliotek.

  • allowSync (Bool) – Ställ in True för att tillåta användare att synkronisera innehåll.

  • allowCameraUpload (Bool) – Ställ in True för att tillåta användare att ladda upp foton.

  • allowChannels (Bool) – Ställ in True för att tillåta användare att använda installerade kanaler.

  • filterMovies (Dict) – Dict innehåller nyckel ’contentRating’ och / eller ’label’ varje uppsättning till en lista ofvalues som ska filtreras. ex: {’contentRating’:,’label’:}

  • filterTelevision (Dict) – dict som innehåller nyckel’ contentRating ’och/eller’ label ’ varje uppsättning till en lista övervärden som ska filtreras. ex: {’contentRating’:, ’label’:}

  • filterMusic (Dict) – dict som innehåller nyckel ’label’ inställd på en lista med värden som ska filtreras.ex: {’label’:}

removeFriend(user) Portugals

Ta bort den angivna användaren från all delning.

parametrar

användare (str) – MyPlexUser, användarnamn, e-post till användaren som ska läggas till.

removeHomeUser(user) Portugals

Ta bort den angivna hanterade användaren hemifrån.

parametrar

användare (str) – MyPlexUser, användarnamn, e-post till användaren som ska tas bort hemifrån.

updateFriend(user, server, sections=None, removeSections=False, allowSync=None, allowCameraUpload=None, allowChannels=None, filterMovies=None, filterTelevision=None, filterMusic=None)

uppdatera den angivna användarens delningsinställningar.

parametrar

  • användare (MyPlexUser) – myplexuser-objekt, användarnamn eller e-postav användaren som ska uppdateras.

  • server (PlexServer) – PlexServer object, eller machineIdentifiercontaining bibliotekssektionerna att dela.

  • sektioner (lista<LibrarySection>) – lista över LibrarySection objecs, eller namnatt delas (Standard Ingen). sektioner måste definieras för att uppdatera delade bibliotek.

  • removeSections (Bool) – Ställ in True för att ta bort alla aktier. Ersätter sektioner.

  • allowSync (Bool) – Ställ in True för att tillåta användare att synkronisera innehåll.

  • allowCameraUpload (Bool) – Ställ in True för att tillåta användare att ladda upp foton.

  • allowChannels (Bool) – Ställ in True för att tillåta användare att använda installerade kanaler.

  • filterMovies (Dict) – Dict innehåller nyckel ’contentRating’ och / eller ’label’ varje uppsättning till en lista ofvalues som ska filtreras. ex: {’contentRating’:, ’etikett’:}

  • filterTelevision (Dict) – Dict som innehåller nyckel ’contentRating’ och / eller ’label’ varje uppsättning till en lista över värden som ska filtreras. ex: {’contentRating’:, ’label’:}

  • filterMusic (Dict) – dict som innehåller nyckel ’label’ inställd på en lista med värden som ska filtreras.ex: {’label’:}

user(användarnamn) Portuguese

returnerarMyPlexUser som matchar det angivna e-postmeddelandet eller användarnamnet.

parametrar

användarnamn (str) – användarnamn, e-post eller id för användaren att återvända.

users() brasilian

returnerar en lista över allaMyPlexUser objekt som är anslutna till ditt konto.Detta inkluderar både vänner och väntande inbjudningar. Du kan referera till användaren.vän todistinguish mellan de två.

optOut(playback=None, library=None)

Välj in eller ut ur att dela saker med plex.Se: https://www.plex.tv/about/privacy-legal/

syncItems(client=None, clientId=None)

returnerar en instans av SyncList för specificerad klient.

parametrar

  • klient (MyPlexDevice) – en klient att söka SyncItems för.

  • clientId (str) – en identifierare för en klient att söka SyncItems för.

om både klient och clientId tillhandahöll klienten skulle föredras.Om varken klient eller clientId tillhandahöll skulle clientId ställas in på nuvarande klienters identifierare.

sync(sync_item, client=None, clientId=None)

lägger till specificerat synkroniseringsobjekt för klienten. Det är alltid lättare att använda metoder som definieras direkt i mediaobjekten, t. ex. sync()sync().

parametrar

  • klient (MyPlexDevice) – en klient som du behöver lägga till SyncItem till.

  • clientId (str) – en identifierare för en klient som du behöver lägga till SyncItem till.

  • sync_item (SyncItem) – förberett SyncItem-objekt med alla fält inställda.

om både klient och clientId tillhandahöll klienten skulle föredras.Om varken klient eller clientId tillhandahöll skulle clientId ställas in på nuvarande klienters identifierare.

returnerar

en instans av skapad syncItem.

returtyp

SyncItem

höjer

  • BadRequest – när klient med medföljande clientId inte hittades.

  • badrequest – tillhandahållen klient tillhandahåller inte synkroniseringsmål.

claimToken()

returnerar en str, en ny ”claim-token”, som du kan använda för att registrera din nya Plex-serverinstans till ditt konto.Se: https://hub.docker.com/r/plexinc/pms-docker/https://www.plex.tv/claim/

history(maxresults=9999999, mindate=None)

hämta spelhistorik för alla bibliotekssektioner på alla servrar för ägaren.: param maxresultat: returnerar bara det angivna antalet resultat (valfritt).: skriv maxresultat:int: param mindate: Min datetime för att returnera resultat från.: typ mindate: datetime

videoOnDemand()¶

Returns a list of VOD Hub items Hub

webShows()¶

Returns a list of Webshow Hub items Hub

news()¶

Returns a list of News Hub items Hub

podcasts()¶

Returns a list of Podcasts Hub items Hub

tidal()¶

Returns a list of tidal Hub items Hub

link(pin)¶

Link a device to the account using a pin kod.

parametrar

pin (str) – den 4-siffriga länkstiftkoden.

classplexapi.myplex.MyPlexUser(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

det här objektet representerar icke-inloggade användare som vänner och linkedaccounts. Detta bör inte förväxlas med MyPlexAccount som är ditt specifika konto. Raw xml för de data som presenteras här kan hittas på: https://plex.tv/api/users/

variabler

  • tagg (str) – ’användare ’

  • nyckel (str) – ’https://plex.tv/api/users/ ’

  • allowCameraUpload (bool) – True om den här användaren kan ladda upp bilder.

  • allowChannels (bool) – True om den här användaren har tillgång till kanaler.

  • allowSync (bool) – sant om den här användaren kan synkronisera.

  • e – post (str) – användarens e-postadress ([email protected]).

  • filterAll (str) – okänd.

  • filterMovies (str) – okänd.

  • filterMusic (str) – okänd.

  • filterPhotos (str) – okänd.

  • filterTelevision (str) – okänd.

  • hem (bool) – okänd.

  • id (int) – användarens Plex-konto-ID.

  • skyddad (falsk) – okänd (möjligen SSL aktiverad?).

  • recommendationsPlaylistId (str) – okänd.

  • begränsad (str) – okänd.

  • thumb (str) – länk till användarens avatar.

  • title (str) – verkar vara en aliad för användarnamn.

  • användarnamn (str) – användarens användarnamn.

  • servers – servrar som delas mellan användare och vän

server(name) Ukrainian

returnerarMyPlexServerShare som matchar det angivna namnet.

parametrar

namn (str) – namnet på servern som ska returneras.

history(maxresults=9999999, mindate=None)

få all spelhistorik för en användare i alla delade servrar.: param maxresultat: returnerar bara det angivna antalet resultat (valfritt).: skriv maxresultat:int: param mindate: Min datetime för att returnera resultat från.: typ mindate: datetime

classplexapi.myplex.Section(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

detta hänvisar till ett delat avsnitt. Raw xml för de data som presenteras här kan hittas på: https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}

variabler

  • tagg (str) – avsnitt

  • id (int) – delat avsnitt id

  • sectionKey (str) – vilken nyckel Vi använder för detta avsnitt

  • Titel (str) – titel på avsnittet

  • sectionid (str) – delat avsnitt id

  • typ (str) – film, tvshow, artist

  • delad (bool) – om det här avsnittet delas med användaren

history(maxresults=9999999, mindate=none)

hämta all spelhistorik för en användare för det här avsnittet i den här delade servern.: param maxresultat: Returnera bara det angivna antalet resultat (valfritt).: skriv maxresultat:int: param mindate: Min datetime för att returnera resultat från.: typ mindate: datetime

klassplexapi.myplex.MyPlexServerShare(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

representerar en enskild användares serverreferens. Används för biblioteksdelning.

variabler

  • id (int) – id för denna andel

  • serverId (str) – vad id plex använder för detta.

  • machineIdentifier (str) – servrarna machineIdentifier

  • namn (str) – servrarna namn

  • lastSeenAt (datetime) – senast ansluten till servern?

  • numLibraries (int) – Totalt antal bibliotek

  • allLibraries (bool) – True om alla bibliotek delas med den här användaren.

  • ägs (bool) – 1 om servern ägs av användaren

  • väntar (bool) – sant om inbjudan väntar.

section(name) Portugals

returnerarSection som matchar det angivna namnet.

parametrar

namn (str) – namnet på det avsnitt som ska returneras.

sections() bisexuell

returnerar en lista över allaSection objekt som delas med den här användaren.

history(maxresults=9999999, mindate=None)

hämta All spelhistorik för en användare i den här delade servern.: param maxresultat: returnerar bara det angivna antalet resultat (valfritt).: skriv maxresultat:int: param mindate: Min datetime för att returnera resultat från.: typ mindate: datetime

classplexapi.myplex.MyPlexResource(server, data,initpath = None, parent=None)

baser: plexapi.base.PlexObject

det här objektet representerar resurser som är anslutna till din Plex-server som kan tillhandahålla innehåll som Plex mediaservrar, iPhone eller Android kunder etc. Den råa xmlför de data som presenteras här finns på:https://plex.tv/api/resources?includeHttps=1&includeRelay=1

variabler

  • TAG (str) – ’Device’

  • nyckel (str) – ’https://plex.tv/api/resources?includeHttps=1&includeRelay=1’

  • accessToken (str) – detta resurser accesstoken.

  • clientIdentifier (str) – unikt ID för denna resurs.

  • anslutningar (Lista) – Lista över ResourceConnection objektför denna resurs.

  • createdAt (datetime) – tidsstämpel denna resurs först ansluten till din server.

  • device (str) – bästa gissning på vilken typ av enhet Detta är (PS, iPhone, Linux, etc).

  • hem (bool) – okänd

  • lastSeenAt (datetime) – tidsstämpel den här resursen senast ansluten.

  • namn (str) – beskrivande namn på denna resurs.

  • owned (bool) – sant om den här resursen är en av dina egna (du loggade in på den).

  • platform (str) – OS resursen körs (Linux, Windows, Chrome, etc.)

  • platformVersion (str) – Version av plattformen.

  • närvaro (bool) – sant om resursen är online

  • produkt (str) – Plex produkt (Plex Media Server, Plex för iOS, Plex Web, etc.)

  • produktversion (str) – Version av produkten.

  • tillhandahåller (str)-lista över tjänster som denna resurs tillhandahåller (klient, server,spelare, pubsub-spelare etc.)

  • synced (bool) – okänd (möjligen sant om resursen har synkroniserat innehåll?)

connect(ssl=None, timeout=None)

returnerar ett nyttPlexServer ellerPlexClient objekt.Ofta finns det mer än en adress som anges för en server eller klient.Den här funktionen prioriterar lokala anslutningar före fjärrkontroll eller relä och HTTPS före HTTP.Efter att ha försökt ansluta till alla tillgängliga adresser för den här resursen ochantar att minst en anslutning lyckades, PlexServer-objektet byggs och returneras.

parametrar

  • ssl (bool, valfritt) – Ställ in True för att bara ansluta till HTTPS-anslutningar. Ställ in False tillanslut bara till HTTP-anslutningar. Ställ in ingen (standard) för att ansluta till någonhttp-eller HTTPS-anslutning.

  • timeout (int, tillval) – timeout i sekunder för att försöka varje anslutning.

höjer

NotFound-när det inte går att ansluta till några adresser för den här resursen.

classplexapi.myplex.ResourceConnection(server, data, initpath=None, parent=None)

baser:plexapi.base.PlexObject

representerar ett Resursanslutningsobjekt som finns iMyPlexResource objekt.

variabler

  • tagg (str) – ’anslutning’

  • adress (str) – lokal IP – adress

  • httpuri (str) – fullständig lokal adress

  • Lokal (bool) – sant om lokal

  • port (int) – 32400

  • protokoll (str) – http eller https

  • Uri (str) – extern adress

klassplexapi.myplex.MyPlexDevice(server, data, initpath=none, parent=none):plexapi.base.PlexObject

det här objektet representerar resurser som är anslutna till din Plex-server som ger uppspelningsförmåga från din Plex-Server, iPhone-eller Android-klienter, Plex Web,detta API, etc. Raw xml för de data som presenteras här finns på:https://plex.tv/devices.xml

variabler

  • tagg (str) – ’enhet’

  • nyckel (str) – ’https://plex.tv/devices.xml’

  • clientIdentifier (str) – unikt ID för denna resurs.

  • anslutningar (Lista) – Lista över Anslutnings Uri för enheten.

  • device (str) – bästa gissning på vilken typ av enhet Detta är (Linux, iPad, AFTB, etc).

  • id (str) – MyPlex-ID för enheten.

  • modell (str) – modell av enheten (bueller, Linux, x86_64, etc.)

  • namn (str) – värdnamn för enheten.

  • platform (str) – OS resursen körs (Linux, Windows, Chrome, etc.)

  • platformVersion (str) – Version av plattformen.

  • produkt (str) – Plex produkt (Plex Media Server, Plex för iOS, Plex Web, etc.)

  • produktversion (sträng) – Version av produkten.

  • tillhandahåller (str)-lista över tjänster som denna resurs tillhandahåller (klient, kontroller,synkroniseringsmål, spelare, pubsub-spelare).

  • publicadress (str) – offentlig IP-adress.

  • skärmdensitet (str) – okänd

  • skärmupplösning (str) – skärmupplösning (750×1334, 1242×2208, etc.)

  • token (str) – Plex autentiseringstoken för enheten.

  • leverantör (str) – enhetsleverantör (ubuntu, etc).

  • version (str) – okänd (1, 2, 1.3.3.3148-b38628e, 1.3.15, etc.)

connect(timeout=None) Portuguese

returnerar ett nyttPlexClient ellerPlexServeribland finns det mer än en adress som anges för en server eller klient.Efter att ha försökt ansluta till alla tillgängliga adresser för den här klienten och antaminst en anslutning lyckades, PlexClient-objektet byggs och returneras.

höjer

NotFound-när det inte går att ansluta till några adresser för den här enheten.

delete() exceptional

Ta bort den här enheten från ditt konto.

syncItems() bisexuell

returnerar en instans avSyncList för aktuell enhet.

höjer

BadRequest-när enheten inte tillhandahåller synkroniseringsmål.

classplexapi.myplex.MyPlexPinLogin(session=None, requestTimeout=None, headers=None)

baser: object

MyPlex PIN inloggningsklass som stöder att få de fyra tecken PIN som användaren mustenter på https://plex.tv/link för att autentisera klienten och ge en åtkomsttoken tillskapa en MyPlexAccount instans.Denna hjälparklass stöder en polling,gängad och återuppringning.

  • polling-metoden förväntar sig att utvecklaren regelbundet kontrollerar om PIN-inloggningen varframgångsrik med checkLogin().

  • den gängade metoden förväntar sig att utvecklaren ska ringarun() och sedan vid ett senare tillfälle ringawaitForLogin() för att vänta på och kontrollera resultatet.

  • callback-metoden är en förlängning av den gängade metoden och förväntar sig att utvecklaren skickar callback-parametern till samtalet tillrun().Återuppringningen kommer att ringas när tråden väntar på PIN-inloggningen för att lyckas antingenavslutar eller löper ut. Parametern som skickas till återuppringningen är den mottagna autentiseringstoken eller ingen om inloggningen löpte ut.

parametrar

  • session (förfrågningar.Sessionsobjekt om du villcache http-svar från PMS

  • requestTimeout (int) – timeout i sekunder på initial ansluta till plex.tv (standard config.TIMEOUT).

variabler

  • stift (str) – ’https://plex.tv/api/v2/pins’

  • kontrollpinnar (str) – ’https://plex.tv/api/v2/pins/{pinid}’

  • länk (str) – ’https://plex.tv/api/v2/pins/link’

  • pollinterval (int) – 1

  • färdig (bool) – om PIN-inloggningen är klar eller inte.

  • utgått (bool) – om pin-inloggningen har löpt ut eller inte.

  • token (str) – Token hämtas via pin-inloggningen.

  • pin (str) – Pin som ska användas för inloggning på https://plex.tv/link.

run(callback=None, timeout=None)

startar tråden som övervakar PIN-inloggningstillståndet.: param återuppringning: återuppringning anropas med den mottagna autentiseringstoken (valfritt).: skriv callback:Callable: param timeout: Timeout i sekunder väntar på att PIN-inloggningen ska lyckas (valfritt).: skriv timeout: Int

höjer

  • RuntimeError-om tråden redan körs.

  • RuntimeError-om PIN-inloggningen för den aktuella PIN-koden har löpt ut.

waitForLogin() Portuguese

väntar på att PIN-inloggningen lyckas eller löper ut.:param callback: återuppringning anropas med den mottagna autentiseringstoken (valfritt).: skriv callback:Callable: param timeout: Timeout i sekunder väntar på att PIN-inloggningen ska lyckas (valfritt).: skriv timeout: Int

returnerar

True om PIN-inloggningen lyckades eller falskt på annat sätt.

stop