l.a.i.w.IFAQTarget(IFAQCollection) : interface documentation

Part of lp.answers.interfaces.webservice View In Hierarchy

Known subclasses: lp.registry.interfaces.webservice.IDistribution, lp.registry.interfaces.webservice.IProduct

An object that can contain a FAQ document.
Method newFAQ Create a new FAQ hosted in this target.
Method findSimilarFAQs Return FAQs contained in this target similar to summary.

Inherited from IFAQCollection:

Method getFAQ Return the IFAQ in this collection with the requested id.
Method searchFAQs Return the FAQs in the collection that matches the search criteria.
def newFAQ(owner, title, content, keywords=None, date_created=None):
Create a new FAQ hosted in this target.
ParametersownerThe IPerson creating the FAQ document.
titleThe document's title.
contentThe document's content.
keywordsThe document's keywords.
date_createdThe creation time of the document. Defaults to now.
def findSimilarFAQs(summary):
Return FAQs contained in this target similar to summary.

Return a list of FAQs similar to the summary provided. These FAQs should be found using a fuzzy search. The list should be ordered from the most similar FAQ to the least similar FAQ

ParameterssummaryA summary phrase.
API Documentation for Launchpad, generated by pydoctor at 2020-10-27 00:00:07.