l.r.i.a.IAnnouncement(Interface) : interface documentation

Part of lp.registry.interfaces.announcement View In Hierarchy

An Announcement.

An announcement is a piece of news which has a headline, summary, and possibly a URL where further information can be found. It also has attributes that determine its publishing state.

Attribute id The unique ID of this announcement
Attribute date_created The date this announcement was registered
Attribute registrant The person who registered this announcement
Attribute date_last_modified The date this announcement was last modified, if ever.
Attribute date_updated The date created, or the date last modified, if ever
Attribute product The product for this announcement.
Attribute projectgroup The project group for this announcement.
Attribute distribution The distribution for this announcement.
Attribute target The pillar to which this announcement belongs.
Attribute title The headline of your announcement.
Attribute summary A single-paragraph summary of the announcement.
Attribute url The web location of your announcement.
Attribute date_announced The date the announcement will be published, or the date it was published if it is in the past. The announcement will only be published on that date if the 'active' flag is True.
Attribute active Whether or not this announcement can be published.
Attribute future Whether or not this announcement is yet public.
Attribute published Whether or not this announcement is published. This is different to IAnnouncement.future because it factors in retraction, while IAnnouncement.future looks only at the date_announced.
Method modify Update the details of the announcement. This will record the
Method retarget Retarget the announcement to a new project.
Method retract Take this announcement off any public web pages and RSS feeds.
Method setPublicationDate Set the publication date. The value passed is either:
Method destroySelf Remove this announcement permanently.
id =
The unique ID of this announcement
date_created =
The date this announcement was registered
registrant =
The person who registered this announcement
date_last_modified =
The date this announcement was last modified, if ever.
date_updated =
The date created, or the date last modified, if ever
product =
The product for this announcement.
projectgroup =
The project group for this announcement.
distribution =
The distribution for this announcement.
target =
The pillar to which this announcement belongs.
title =
The headline of your announcement.
summary =
A single-paragraph summary of the announcement.
url =
The web location of your announcement.
date_announced =
The date the announcement will be published, or the date it was published if it is in the past. The announcement will only be published on that date if the 'active' flag is True.
active =
Whether or not this announcement can be published.
future =
Whether or not this announcement is yet public.
published =
Whether or not this announcement is published. This is different to IAnnouncement.future because it factors in retraction, while IAnnouncement.future looks only at the date_announced.
def modify(title, summary, url):
Update the details of the announcement. This will record the date_last_modified.
def retarget(target):
Retarget the announcement to a new project.
def retract():
Take this announcement off any public web pages and RSS feeds.
def setPublicationDate(publication_date):
Set the publication date. The value passed is either:

None: publish it at some future date, A datetime: publish it on the date given.

def destroySelf():
Remove this announcement permanently.
API Documentation for Launchpad, generated by pydoctor at 2019-08-25 00:00:07.