Files
plexjs/docs/models/operations/user.md

10 KiB
Raw Permalink Blame History

User

Example Usage

import {
  AllLibraries,
  AllowCameraUpload,
  AllowChannels,
  AllowSubtitleAdmin,
  AllowSync,
  AllowTuners,
  Home,
  Owned,
  Pending,
  Protected,
  Restricted,
  User,
} from "@lukehagar/plexjs/models/operations";

let value: User = {
  id: 22526914,
  title: "Plex User",
  username: "zgfuc7krcqfimrmb9lsl5j",
  email: "zgfuc7krcqfimrmb9lsl5j@protonmail.com",
  recommendationsPlaylistId: "",
  thumb: "https://plex.tv/users/3346028014e93acd/avatar?c=1731605021",
  protected: Protected.Enable,
  home: Home.Enable,
  allowTuners: AllowTuners.Enable,
  allowSync: AllowSync.Enable,
  allowCameraUpload: AllowCameraUpload.Enable,
  allowChannels: AllowChannels.Enable,
  allowSubtitleAdmin: AllowSubtitleAdmin.Enable,
  filterAll: "",
  filterMovies: "",
  filterMusic: "",
  filterPhotos: "",
  filterTelevision: "",
  restricted: Restricted.Enable,
  server: [
    {
      id: 907759180,
      serverId: 9999999,
      machineIdentifier: "fbb8aa6be6e0c997c6268bc2b4431c8807f70a3",
      name: "ConnectedUserFlix",
      lastSeenAt: 1556281940,
      numLibraries: 16,
      allLibraries: AllLibraries.Enable,
      owned: Owned.Enable,
      pending: Pending.Enable,
    },
  ],
};

Fields

Field Type Required Description Example
id number ✔️ User's unique ID. 22526914
title string ✔️ User's display name. Plex User
username string ✔️ User's username. zgfuc7krcqfimrmb9lsl5j
email string ✔️ User's email address. zgfuc7krcqfimrmb9lsl5j@protonmail.com
recommendationsPlaylistId string ID of the user's recommendation playlist.
thumb string ✔️ URL to the user's avatar image. https://plex.tv/users/3346028014e93acd/avatar?c=1731605021
protected operations.Protected N/A 1
home operations.Home N/A 1
allowTuners operations.AllowTuners N/A 1
allowSync operations.AllowSync N/A 1
allowCameraUpload operations.AllowCameraUpload N/A 1
allowChannels operations.AllowChannels N/A 1
allowSubtitleAdmin operations.AllowSubtitleAdmin N/A 1
filterAll string Filters applied for all content.
filterMovies string Filters applied for movies.
filterMusic string Filters applied for music.
filterPhotos string Filters applied for photos.
filterTelevision string Filters applied for television.
restricted operations.Restricted N/A 1
server operations.Server[] ✔️ List of servers owned by the user.