pyams_notify.interfaces package ⊞

interface pyams_notify.interfaces.INotification[source]

Notification interface

action

Notification action

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
category

Notification category

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
title

Notification title

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
message

Notification message

Implementation:zope.schema.Text
Read Only:False
Required:True
Default Value:None
Allowed Type:str
source

Notification source

Attributes of the principal which emitted the notification

Implementation:zope.schema.Dict
Read Only:False
Required:True
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
target

Notification target

Notification targets (principals, roles…)

Implementation:zope.schema.Dict
Read Only:False
Required:True
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
url

Notification URL

URL targetted by this notification

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
timestamp

Notification timestamp

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
user_data

User data

Implementation:zope.schema.Dict
Read Only:False
Required:True
Default Value:None
Allowed Type:dict
send(self)

Send notification to recipients

interface pyams_notify.interfaces.INotificationHandler[source]

Notification handler interface

get_target(self)

Get notification target

interface pyams_notify.interfaces.IUserProfileAnnotations[source]

User profile annotations subscriptions