Class MyPlexDevice

This object represents resources connected to your Plex server that provide playback ability from your Plex Server, iPhone or Android clients, Plex Web, this API, etc. The raw xml for the data presented here can be found at: https://plex.tv/devices.xml

Hierarchy

  • PlexObject
    • MyPlexDevice

Constructors

constructor

Properties

clientIdentifier connections? createdAt device id key lastSeenAt model name parent? platform platformVersion product productVersion provides publicAddress screenDensity screenResolution server token vendor version TAG TYPE key

Methods

connect delete isChildOf refresh reload

Constructors

constructor

  • new MyPlexDevice(server, data, initpath?, parent?): MyPlexDevice

  • Parameters

    • server: PlexServer
    • data: any
    • Optionalinitpath: string
    • Optionalparent: PlexObject

    Returns MyPlexDevice

Properties

clientIdentifier

clientIdentifier: string

Optionalconnections

connections?: string[]

List of connection URIs for the device.

createdAt

createdAt: Date

device

device: string

id

id: string

key

key: string

plex relative url

lastSeenAt

lastSeenAt: Date

model

model: string

name

name: string

Optional Readonlyparent

parent?: WeakRef<any>

WeakRef to the parent object that this object is built from.

platform

platform: string

platformVersion

platformVersion: string

product

product: string

productVersion

productVersion: string

provides

provides: string

publicAddress

publicAddress: string

screenDensity

screenDensity: string

screenResolution

screenResolution: string

Readonlyserver

server: PlexServer

token

token: string

vendor

vendor: string

version

version: string

StaticTAG

TAG: string = 'Device'

xml element tag

StaticTYPE

TYPE: string = null

xml element type

Statickey

key: string = 'https://plex.tv/devices.xml'

Methods

connect

delete

  • delete(): Promise<void>

  • Remove this device from your account

    Returns Promise<void>

isChildOf

  • isChildOf(cls): boolean

  • Returns True if this object is a child of the given class.

    Parameters

    • cls: any

    Returns boolean

refresh

  • refresh(): Promise<void>

  • Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

    Returns Promise<void>

reload

  • reload(ekey?): Promise<void>

  • Reload the data for this object from this.key.

    Parameters

    • Optionalekey: string

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods