Add maxResults and mindate to all history methods

Author: zSeriesGuy

plexapi/base.py

@@ -421,9 +421,13 @@ def delete(self):
                 'havnt allowed items to be deleted' % self.key)
             raise
 
-    def history(self):
-        """ Get Play History for a media item. """
-        return self._server.history(ratingKey=self.ratingKey)
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get Play History for a media item.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
+        return self._server.history(maxresults=maxresults, mindate=mindate, ratingKey=self.ratingKey)
 
 
     # The photo tag cant be built atm. TODO

plexapi/library.py

@@ -294,11 +294,15 @@ def add(self, name='', type='', agent='', scanner='', location='', language='en'
             part += urlencode(kwargs)
         return self._server.query(part, method=self._server._session.post)
 
-    def history(self):
-        """ Get Play History for all library Sections for the owner. """
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get Play History for all library Sections for the owner.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
         hist = []
         for section in self.sections():
-            hist.extend(section.history())
+            hist.extend(section.history(maxresults=maxresults, mindate=mindate))
         return hist
 
 
@@ -640,9 +644,13 @@ def sync(self, policy, mediaSettings, client=None, clientId=None, title=None, so
 
         return myplex.sync(client=client, clientId=clientId, sync_item=sync_item)
 
-    def history(self):
-        """ Get Play History for this library Section for the owner. """
-        return self._server.history(librarySectionID=self.key, accountID=1)
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get Play History for this library Section for the owner.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
+        return self._server.history(maxresults=maxresults, mindate=mindate, librarySectionID=self.key, accountID=1)
 
 
 class MovieSection(LibrarySection):

plexapi/myplex.py

@@ -600,13 +600,17 @@ def claimToken(self):
             raise BadRequest('(%s) %s %s; %s' % (response.status_code, codename, response.url, errtext))
         return response.json()['token']
 
-    def history(self):
-        """ Get Play History for all library sections on all servers for the owner. """
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get Play History for all library sections on all servers for the owner.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
         servers = [x for x in self.resources() if x.provides == 'server' and x.owned]
         hist = []
         for server in servers:
             conn = server.connect()
-            hist.extend(conn.history(accountID=1))
+            hist.extend(conn.history(maxresults=maxresults, mindate=mindate, accountID=1))
         return hist
 
 
@@ -686,11 +690,15 @@ def server(self, name):
 
         raise NotFound('Unable to find server %s' % name)
 
-    def history(self):
-        """ Get all Play History for a user in all shared servers. """
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get all Play History for a user in all shared servers.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
         hist = []
         for server in self.servers:
-            hist.extend(server.history())
+            hist.extend(server.history(maxresults=maxresults, mindate=mindate))
         return hist
 
 
@@ -719,10 +727,15 @@ def _loadData(self, data):
         self.type = data.attrib.get('type')
         self.shared = utils.cast(bool, data.attrib.get('shared'))
 
-    def history(self):
-        """ Get all Play History for a user for this section in this shared server. """
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get all Play History for a user for this section in this shared server.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
         server = self._server._server.resource(self._server.name).connect()
-        return server.history(accountID=self._server.accountID, librarySectionID=self.sectionKey)
+        return server.history(maxresults=maxresults, mindate=mindate,
+                              accountID=self._server.accountID, librarySectionID=self.sectionKey)
 
 
 class MyPlexServerShare(PlexObject):
@@ -781,10 +794,14 @@ def sections(self):
 
         return sections
 
-    def history(self):
-        """ Get all Play History for a user in this shared server. """
+    def history(self, maxresults=9999999, mindate=None):
+        """ Get all Play History for a user in this shared server.
+            Parameters:
+                maxresults (int): Only return the specified number of results (optional).
+                mindate (datetime): Min datetime to return results from.
+        """
         server = self._server.resource(self.name).connect()
-        return server.history(accountID=self.accountID)
+        return server.history(maxresults=maxresults, mindate=mindate, accountID=self.accountID)
 
 
 class MyPlexResource(PlexObject):