Interface InviteFriendOptions

interface InviteFriendOptions {
    filters?: LibraryShareFilters;
    permissions?: LibrarySharePermissions;
    sections?: readonly LibraryShareSection[];
    server: string | PlexServer;
}

Hierarchy (View Summary)

InviteFriendOptions
- UpdateFriendOptions

Index

Properties

filters? permissions? sections? server

Properties

`Optional`filters

filters?: LibraryShareFilters

Optional content and label restrictions by library family.

`Optional`permissions

permissions?: LibrarySharePermissions

Account capabilities granted to the invited user.

`Optional`sections

sections?: readonly LibraryShareSection[]

Libraries to share. Omit or pass an empty list to invite without libraries.

server

server: string | PlexServer

Plex server or machine identifier containing the libraries.