Table of Contents

Class: Subscription Subscription.py

Subscription

Placefull Object containing subscription information.

Base Classes   
PortalFolder
Methods   
__init__
addEventType
addObjectType
getFilterEventTypes
getFilterObjectTypes
getNotificationRules
getRecipientEmailsBlackList
getRecipientsRules
isInterestedInEvent
sendEvent
updateRecipientEmailsBlackList
  __init__ 
__init__ (
        self,
        id,
        title='',
        )

Constructor

  addEventType 
addEventType ( self,  event_type )

Adds a new event type on wich to r ex: workflow_modify

  addObjectType 
addObjectType ( self,  object_type )

Adds a new object type concerned with the subscription.

  getFilterEventTypes 
getFilterEventTypes ( self )

Returns the event types on which to react

ex: workflow_create, workflow_in_publish

  getFilterObjectTypes 
getFilterObjectTypes ( self )

Returns the types of objects concerned by the subscription.

The subscription is valid only if the context object's portal_type is in object_types.

  getNotificationRules 
getNotificationRules ( self )

Returns the notification rule associate to this object

  getRecipientEmailsBlackList 
getRecipientEmailsBlackList ( self )

Returns the list of emails blocked by the subscription.

  getRecipientsRules 
getRecipientsRules ( self,  recipients_rule_type=None )

Get the recipient rules objects.

if recipient_rule_type is None, then we return all the recipients rule objects defined for a this given subscription object. If not None we return the given recipients rule objects matching the requested type.

The different types of recipients rule objects : - Role Recipients Rulz - Explicit Recipients Rule - Computed Recipents Rule - Workflow Implied Recipients Rule

  isInterestedInEvent 
isInterestedInEvent (
        self,
        event_type,
        object,
        infos,
        )

Is the subscription interested in the given event.

  sendEvent 
sendEvent (
        self,
        event_type,
        object,
        infos,
        )

Send an event to the subscription.

  updateRecipientEmailsBlackList 
updateRecipientEmailsBlackList ( self,  emails=[] )

Adds a new email to the emails black list


Table of Contents

This document was automatically generated on Wed Mar 31 00:28:10 2004 by HappyDoc version WORKING