Added class/libtype for collections and library search function

Author: dirtycajunrice

plexapi/library.py

@@ -565,6 +565,10 @@ class MovieSection(LibrarySection):
     TAG = 'Directory'
     TYPE = 'movie'
 
+    def collection(self, **kwargs):
+        """ Returns a list of collections from this library section. """
+        return self.search(libtype='collection', **kwargs)
+
 
 class ShowSection(LibrarySection):
     """ Represents a :class:`~plexapi.library.LibrarySection` section containing tv shows.
@@ -600,6 +604,10 @@ def recentlyAdded(self, libtype='episode', maxresults=50):
         """
         return self.search(sort='addedAt:desc', libtype=libtype, maxresults=maxresults)
 
+    def collection(self, **kwargs):
+        """ Returns a list of collections from this library section. """
+        return self.search(libtype='collection', **kwargs)
+
 
 class MusicSection(LibrarySection):
     """ Represents a :class:`~plexapi.library.LibrarySection` section containing music artists.
@@ -634,6 +642,10 @@ def searchTracks(self, **kwargs):
         """ Search for a track. See :func:`~plexapi.library.LibrarySection.search()` for usage. """
         return self.search(libtype='track', **kwargs)
 
+    def collection(self, **kwargs):
+        """ Returns a list of collections from this library section. """
+        return self.search(libtype='collection', **kwargs)
+
 
 class PhotoSection(LibrarySection):
     """ Represents a :class:`~plexapi.library.LibrarySection` section containing photos.
@@ -714,3 +726,25 @@ def _loadData(self, data):
 
     def __len__(self):
         return self.size
+
+@utils.registerPlexObject
+class Collections(PlexObject):
+
+    TAG = 'Directory'
+    TYPE = 'collection'
+
+    def _loadData(self, data):
+        self.ratingKey = data.attrib.get('ratingKey')
+        self.key = data.attrib.get('key')
+        self.type = data.attrib.get('type')
+        self.title = data.attrib.get('title')
+        self.subtype = data.attrib.get('subtype')
+        self.summary = data.attrib.get('summary')
+        self.index = data.attrib.get('index')
+        self.thumb = data.attrib.get('thumb')
+        self.addedAt = data.attrib.get('addedAt')
+        self.updatedAt = data.attrib.get('updatedAt')
+        self.childCount = data.attrib.get('childCount')
+        self.maxYear = data.attrib.get('maxYear')
+        self.children = self.fetchItems(self.key)
+

plexapi/utils.py

@@ -15,7 +15,8 @@
 # Search Types - Plex uses these to filter specific media types when searching.
 # Library Types - Populated at runtime
 SEARCHTYPES = {'movie': 1, 'show': 2, 'season': 3, 'episode': 4,
-               'artist': 8, 'album': 9, 'track': 10, 'photo': 14}
+               'artist': 8, 'album': 9, 'track': 10, 'photo': 14,
+               'collection': 18}
 PLEXOBJECTS = {}
 
 
@@ -129,8 +130,8 @@ def searchType(libtype):
     """ Returns the integer value of the library string type.
 
         Parameters:
-            libtype (str): LibType to lookup (movie, show, season, episode, artist, album, track)
-
+            libtype (str): LibType to lookup (movie, show, season, episode, artist, album, track,
+                                              collection)
         Raises:
             NotFound: Unknown libtype
     """