Home | Trees | Indices | Help |
|
---|
|
object --+ | Client
Client for sending push notificiations to iOS devices with the Prowl application installed. Member Vars: apikeys: A list of strings, each containing a 40 character api key. providerkey: A string containing a 40 character provider key.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
Inherited from |
|
Initialize the Prowl client. Args: apikeys: A list of strings of 40 characters each, each containing a valid api key. providerkey: A string of 40 characters containing a valid provider key.
|
Send a notification to each apikey in self.apikeys. Args: app: A string of up to 256 characters containing the name of the application sending the notification. event: A string of up to 1024 characters containing the event that is being notified (i.e. subject or brief description.) desc: A string of up to 10000 characters containing the notification text. kwargs: A dictionary with any of the following strings as keys: priority: An integer between -2 and 2, indicating the priority of the notification. -2 is the lowest, 2 is the highest, and 0 is normal. url: A string of up to 512 characters containing a URL to attach to the notification. (default: None) Raises: pushnotify.exceptions.FormatError pushnotify.exceptions.ApiKeyError pushnotify.exceptions.RateLimitExceeded pushnotify.exceptions.ServerError pushnotify.exceptions.UnknownError pushnotify.exceptions.UnrecognizedResponseError |
Get an API key for a given token. Once a user has approved you sending them push notifications, you can supply the returned token here and get an API key. Args: token: A string containing a registration token returned from the retrieve_token method. Raises: pushnotify.exceptions.ProviderKeyError Returns: A string containing the API key. |
Get a registration token and approval URL. A user follows the URL and logs in to the Prowl website to approve you sending them push notifications. If you've associated a 'Retrieve success URL' with your provider key, they will be redirected there. Raises: pushnotify.exceptions.ProviderKeyError Returns: A two-item tuple where the first item is a string containing a registration token, and the second item is a string containing the associated URL. |
Verify an API key for a user. Args: apikey: A string of 40 characters containing an API key. Raises: pushnotify.exceptions.RateLimitExceeded pushnotify.exceptions.ServerError pushnotify.exceptions.UnknownError pushnotify.exceptions.UnrecognizedResponseError Returns: A boolean containing True if the API key is valid, and False if it is not. |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Thu Sep 20 20:21:12 2012 | http://epydoc.sourceforge.net |