Commits

Jeffrey Goettsch committed 8b6eec2

Updated pydoc for pushnotify.pushover.Client.

Comments (0)

Files changed (1)

pushnotify/pushover.py

     with the Pushover application installed.
 
     Member Vars:
-        token: A string containing a valid API token.
+        developerkey: A string containing a valid provider key for the
+            given Pushover client.
+        application: A string containing the name of the application on
+            behalf of whom the Pushover client will be sending messages.
+        apikeys: A dictionary where the keys are strings containing
+            valid user API keys, and the values are lists of strings,
+            each containing a valid user device key.
 
     """
 
 
         Args:
             developerkey: A string containing a valid provider key for
-                the Prowl client.
+                the Pushover client.
             application: A string containing the name of the application
-                on behalf of whom the Prowl client will be sending
+                on behalf of whom the Pushover client will be sending
                 messages.
 
         """
             raise exceptions.UnrecognizedResponseError(msg, self._last['code'])
 
     def notify(self, description, event, split=True, kwargs=None):
-        """Send a notification to each user/device in self.users.
+        """Send a notification to each user's API key/device key
+        combintation in self.apikeys.
 
         As of 2012-09-18, this is not returning a 4xx status code as
         per the Pushover API docs, but instead chopping the delivered
         messages off at 512 characters.
 
         Args:
-            title: A string of up to 100 characters containing the
-                title of the message (i.e. subject or brief description)
-            message: A string of up to 512 characters containing the
-                notification text.
+            description: A string of up to DESC_LIMIT characters
+                containing the notification text.
+            event: A string of up to 100 characters containing a
+                subject or brief description of the event.
+            split: A boolean indicating whether to split long
+                descriptions among multiple notifications (True) or to
+                possibly raise an exception (False). (default True)
             kwargs: A dictionary with any of the following strings as
                     keys:
                 priority: The integer 1, which will make the
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.