Class MyPlexInvite

Index

Constructors

Properties

account createdAt? direction email? friend friendlyName? home id? server servers thumb? username? requestedKey requestsKey

Methods

Constructors

constructor

new MyPlexInvite(
    account: MyPlexAccount,
    data: MyPlexInviteData,
    direction: MyPlexInviteDirection,
): MyPlexInvite
Parameters
- account: MyPlexAccount
- data: MyPlexInviteData
- direction: MyPlexInviteDirection
Returns MyPlexInvite
- Defined in src/myplex.ts:1180

Properties

`Readonly`account

account: MyPlexAccount

`Optional` `Readonly`createdAt

createdAt?: Date

`Readonly`direction

direction: MyPlexInviteDirection

`Optional` `Readonly`email

email?: string

`Readonly`friend

friend: boolean

`Optional` `Readonly`friendlyName

friendlyName?: string

`Readonly`home

home: boolean

`Optional` `Readonly`id

id?: number

`Readonly`server

server: boolean

`Readonly`servers

servers: MyPlexServerShare[]

`Optional` `Readonly`thumb

thumb?: string

`Optional` `Readonly`username

username?: string

`Static` `Readonly`requestedKey

requestedKey: "https://plex.tv/api/invites/requested" = 'https://plex.tv/api/invites/requested'

`Static` `Readonly`requestsKey

requestsKey: "https://plex.tv/api/invites/requests" = 'https://plex.tv/api/invites/requests'

Methods

accept

accept(): Promise<void>
Accept this received invite.

Returns Promise<void>
- Defined in src/myplex.ts:1196

cancel

cancel(): Promise<void>
Cancel this sent invite.

Returns Promise<void>
- Defined in src/myplex.ts:1201