plexjs/docs/models/friend.md

Friend

Example Usage

import { Friend, Status } from "@lukehagar/plexjs";

let value: Friend = {
    email: "username@email.com",
    friendlyName: "exampleUser",
    home: true,
    id: 0,
    restricted: false,
    sharedServers: [{}],
    sharedSources: [{}],
    status: Status.Accepted,
    thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
    title: "username123",
    username: "username123",
    uuid: "7d1916e0d8f6e76b",
};

Fields

Field	Type	Required	Description	Example
email	string	✔️	The account email address	username@email.com
friendlyName	string	✔️	The account full name	exampleUser
home	boolean	✔️	If the account is a Plex Home user
id	number	✔️	The Plex account ID
restricted	boolean	➖	If the account is a Plex Home managed user
sharedServers	models.SharedServers[]	✔️	N/A
sharedSources	models.SharedSources[]	✔️	N/A
status	models.Status	✔️	Current friend request status	accepted
thumb	string	✔️	URL of the account thumbnail	https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578
title	string	✔️	The title of the account (username or friendly name)	username123
username	string	✔️	The account username	username123
uuid	string	✔️	The account Universally Unique Identifier (UUID)	7d1916e0d8f6e76b