Skip to content

Latest commit

 

History

History
107 lines (81 loc) · 7.46 KB

README.md

File metadata and controls

107 lines (81 loc) · 7.46 KB

Users

(users)

Overview

Available Operations

  • getUsers - Get list of all connected users

getUsers

Get list of all users that are friends and have library access with the provided Plex authentication token

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI();

async function run() {
  const result = await plexAPI.users.getUsers({
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    deviceNickname: "Roku 3",
    deviceName: "Chrome",
    deviceScreenResolution: "1487x1165,2560x1440",
    clientVersion: "2.4.1",
    platform: "Roku",
    clientFeatures: "external-media,indirect-media,hub-style-list",
    model: "4200X",
    xPlexSessionId: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
    xPlexLanguage: "en",
    platformVersion: "4.3 build 1057",
    xPlexToken: "CV5xoxjTpFKUzBTShsaf",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { usersGetUsers } from "@lukehagar/plexjs/funcs/usersGetUsers.js";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore();

async function run() {
  const res = await usersGetUsers(plexAPI, {
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    deviceNickname: "Roku 3",
    deviceName: "Chrome",
    deviceScreenResolution: "1487x1165,2560x1440",
    clientVersion: "2.4.1",
    platform: "Roku",
    clientFeatures: "external-media,indirect-media,hub-style-list",
    model: "4200X",
    xPlexSessionId: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
    xPlexLanguage: "en",
    platformVersion: "4.3 build 1057",
    xPlexToken: "CV5xoxjTpFKUzBTShsaf",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.GetUsersRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.
options.serverURL string ➖ An optional server URL to use.

Response

Promise<operations.GetUsersResponse>

Errors

Error Type Status Code Content Type
errors.GetUsersBadRequest 400 application/json
errors.GetUsersUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*