Class MyPlexUser

constructor

• new MyPlexUser(account: MyPlexAccount, data: MyPlexUserData): MyPlexUser

  Parameters

  • account: MyPlexAccount
  • data: MyPlexUserData

  Returns MyPlexUser

Readonlyaccount

ReadonlyallowCameraUpload

ReadonlyallowChannels

ReadonlyallowSync

Optional Readonlyemail

Optional ReadonlyfilterAll

Optional ReadonlyfilterMovies

Optional ReadonlyfilterMusic

Optional ReadonlyfilterPhotos

Optional ReadonlyfilterTelevision

Readonlyfriend

Readonlyhome

Optional Readonlyid

Readonlyprotected

Optional ReadonlyrecommendationsPlaylistId

Optional Readonlyrestricted

Readonlyservers

Optional Readonlythumb

Optional Readonlytitle

Optional Readonlyusername

Static Readonlykey

getToken

• getToken(machineIdentifier: string): Promise<string | undefined>

  Fetch this user's server-scoped access token using the owning account.

  Parameters

  • machineIdentifier: string

  Returns Promise<string | undefined>

history

• history(
      options?: Pick<HistoryOptions, "maxResults" | "minDate">,
  ): Promise<HistoryResult[]>

  Parameters

  • options: Pick<HistoryOptions, "maxResults" | "minDate"> = {}

  Returns Promise<HistoryResult[]>

removeFriend

• removeFriend(): Promise<void>

  Remove this user from the account's friends.

  Returns Promise<void>

removeHomeUser

• removeHomeUser(): Promise<void>

  Remove this managed user from the account's Plex Home.

  Returns Promise<void>

server

• server(identifier: string): MyPlexServerShare

  Find a server shared with this user by name or machine identifier.

  Parameters

  • identifier: string

  Returns MyPlexServerShare