@ctrl/plex
    Preparing search index...

    Class Common

    Hierarchy

    • PlexObject
      • Common
    Index

    Constructors

    constructor

    Properties

    collections contentRating? countries directors editionTitle? fields genres grandparentRatingKey? grandparentTitle? guid? guids index? key labels mixedFields moods originallyAvailableAt? parent? parentRatingKey? parentTitle? producers ratingKey? ratings roles server studio? styles summary? tagline? tags title? titleSort? type? writers year? TAG TYPE

    Accessors

    commonType ratingKeys

    Methods

    isChildOf items refresh reload

    Constructors

    • Parameters

      • server: PlexServer
      • data: any
      • Optionalinitpath: string
      • Optionalparent: PlexObject

      Returns Common

    Properties

    collections: Collection[]
    contentRating?: string
    countries: Country[]
    directors: Director[]
    editionTitle?: string
    fields: Field[]
    genres: Genre[]
    grandparentRatingKey?: number
    grandparentTitle?: string
    guid?: string
    guids: Guid[]
    index?: number
    key: string

    plex relative url

    labels: Label[]
    mixedFields: string[]
    moods: Mood[]
    originallyAvailableAt?: Date
    parent?: WeakRef<any>

    WeakRef to the parent object that this object is built from.

    parentRatingKey?: number
    parentTitle?: string
    producers: Producer[]
    ratingKey?: number
    ratings: Rating[]
    roles: Role[]
    server: PlexServer
    studio?: string
    styles: Style[]
    summary?: string
    tagline?: string
    tags: Tag[]
    title?: string
    titleSort?: string
    type?: string
    writers: Writer[]
    year?: number
    TAG: string = 'Common'

    xml element tag

    TYPE: string = null

    xml element type

    Accessors

    • get commonType(): | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"

      Returns
          | "track"
          | "artist"
          | "album"
          | "movie"
          | "show"
          | "season"
          | "episode"
          | "trailer"
          | "comic"
          | "person"
          | "picture"
          | "clip"
          | "photo"
          | "photoalbum"
          | "playlist"
          | "playlistFolder"
          | "collection"
          | "optimizedVersion"
          | "userPlaylistItem"

    Methods

    • Returns True if this object is a child of the given class.

      Parameters

      • cls: any

      Returns boolean

    • Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

      Returns Promise<void>

    • Reload the data for this object from this.key.

      Parameters

      • Optionalekey: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods