Home       Trees       Indices       Help   
S3
Package s3 :: Module s3notify :: Class S3Notifications
[frames] | no frames]

Class S3Notifications

source code

object --+
         |
        S3Notifications

Framework to send notifications about subscribed events

Instance Methods

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods
 
check_subscriptions(cls)
Scheduler entry point, creates notification tasks for all active subscriptions which (may) have updates.		 source code
 
notify(cls, resource_id)
Asynchronous task to notify a subscriber about updates, runs a POST?format=msg request against the subscribed controller which extracts the data and renders and sends the notification message (see send()).		 source code
 
send(cls, r, resource)
Method to retrieve updates for a subscription, render the notification message and send it - responds to POST?format=msg requests to the respective resource.		 source code
Properties

Inherited from object: __class__

Method Details

check_subscriptions(cls)
Class Method

source code 

Scheduler entry point, creates notification tasks for all active subscriptions which (may) have updates.

notify(cls, resource_id)
Class Method

source code 

Asynchronous task to notify a subscriber about updates, runs a POST?format=msg request against the subscribed controller which extracts the data and renders and sends the notification message (see send()).

Parameters:
  • resource_id - the pr_subscription_resource record ID

send(cls, r, resource)
Class Method

source code 

Method to retrieve updates for a subscription, render the notification message and send it - responds to POST?format=msg requests to the respective resource.

Parameters:
  • r - the S3Request
  • resource - the S3Resource

   Home       Trees       Indices       Help   
S3
Generated by Epydoc 3.0.1 on Fri Mar 15 08:51:50 2019 http://epydoc.sourceforge.net