| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
abstract.AbstractClient --+
|
Client
Client for sending push notificiations to iOS devices with
the Prowl application installed.
Member Vars:
developerkey: A string containing a valid provider key for the
Prowl application.
application: A string containing the name of the application on
behalf of whom the Prowl 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. Device keys are not
used by this client.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
|
|||
|
Inherited from |
|||
|
|||
Initialize the Prowl client.
Args:
developerkey: A string containing a valid provider key for
the Prowl application.
application: A string containing the name of the application
on behalf of whom the Prowl client will be sending
messages.
|
Send a notification to each user's apikey in self.apikeys.
Args:
description: A string of up to DESC_LIMIT characters
containing the notification text.
event: A string of up to 1024 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: 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.ApiKeyError
pushnotify.exceptions.FormatError
pushnotify.exceptions.RateLimitExceeded
pushnotify.exceptions.ServerError
pushnotify.exceptions.UnknownError
pushnotify.exceptions.UnrecognizedResponseError
|
Get a user's API key for a given registration token.
Once a user has approved you sending them push notifications,
you can supply the returned token here and get an API key.
Args:
reg_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 approval URL and logs in to the Prowl website
to approve you sending them push notifications. If you have
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 a user's API key.
Args:
apikey: A string of 40 characters containing a user's API
key.
Raises:
pushnotify.exceptions.RateLimitExceeded
pushnotify.exceptions.ServerError
pushnotify.exceptions.UnknownError
pushnotify.exceptions.UnrecognizedResponseError
Returns:
A boolean containing True if the user's API key is valid,
and False if it is not.
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Wed Oct 3 20:47:38 2012 | http://epydoc.sourceforge.net |