l.b.i.s.IStructuralSubscriptionTargetWrite(Interface) : interface documentation

Part of lp.bugs.interfaces.structuralsubscription View In Hierarchy

Known subclasses: lp.bugs.interfaces.webservice.IStructuralSubscriptionTarget

A Launchpad Structure allowing users to subscribe to it.

Modify-only parts.

Method addSubscription Add a subscription for this structure.
Method addBugSubscription Add a bug subscription for this structure.
Method addBugSubscriptionFilter Add a bug subscription filter for this structure.
Method removeBugSubscription Remove a subscription to bugs from this structure.
def addSubscription(subscriber, subscribed_by):
Add a subscription for this structure.

This method is used to create a new IStructuralSubscription for the target.

ReturnsThe new subscription.
Unknown Field: subscriberThe IPerson who will be subscribed. If omitted, subscribed_by will be used.
Unknown Field: subscribed_byThe IPerson creating the subscription.
@operation_parameters(Reference(IPerson, _('Person to subscribe. If omitted, the requesting user will be subscribed.'), False))
@call_with(REQUEST_USER)
@export_factory_operation(IStructuralSubscription, )
@operation_for_version('beta')
def addBugSubscription(subscriber, subscribed_by):
Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

ReturnsThe new bug subscription.
Unknown Field: subscriberThe IPerson who will be subscribed. If omitted, subscribed_by will be used.
Unknown Field: subscribed_byThe IPerson creating the subscription.
@operation_parameters(Reference(IPerson, _('Person to subscribe. If omitted, the requesting user will be subscribed.'), False))
@call_with(REQUEST_USER)
@export_factory_operation(Interface, )
@operation_for_version('beta')
def addBugSubscriptionFilter(subscriber, subscribed_by):
Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

ReturnsThe new bug subscription filter.
Unknown Field: subscriberThe IPerson who will be subscribed. If omitted, subscribed_by will be used.
Unknown Field: subscribed_byThe IPerson creating the subscription.
@operation_parameters(Reference(IPerson, _('Person to unsubscribe. If omitted, the requesting user will be unsubscribed.'), False))
@call_with(REQUEST_USER)
@export_write_operation()
@operation_for_version('beta')
def removeBugSubscription(subscriber, unsubscribed_by):
Remove a subscription to bugs from this structure.

This will delete all associated filters.

Unknown Field: subscriberThe IPerson who will be unsubscribed. If omitted, unsubscribed_by will be used.
Unknown Field: unsubscribed_byThe IPerson removing the subscription.
API Documentation for Launchpad, generated by pydoctor at 2019-09-23 00:00:04.