l.c.i.b.IBranchMergeProposalAnyAllowedPerson(IBugLinkTarget) : interface documentation

Part of lp.code.interfaces.branchmergeproposal View In Hierarchy

Known subclasses: lp.code.interfaces.webservice.IBranchMergeProposal

No interface docstring
Method createComment Create an ICodeReviewComment associated with this merge proposal.
Method createCommentFromMessage Create an ICodeReviewComment from an IMessage.
Method getDraftInlineComments Return the draft inline comments related to this MP.
Method saveDraftInlineComment Save ICodeReviewInlineCommentDraft
Method linkBug Link a bug to this merge proposal.
Method unlinkBug Unlink a bug from this merge proposal.
@operation_parameters(Text(), Text(), Choice(CodeReviewVote), Text(), Reference(Interface), Int(), Dict(TextLine(), Text()))
@call_with(REQUEST_USER)
@export_factory_operation(Interface, )
def createComment(owner, subject, content=None, vote=None, review_type=None, parent=None, previewdiff_id=None, inline_comments=None):
Create an ICodeReviewComment associated with this merge proposal.
ParametersownerThe person who the message is from.
subjectThe subject line to use for the message.
contentThe text to use for the message content. If unspecified, the text of the merge proposal is used.
parentThe previous CodeReviewComment in the thread. If unspecified, the root message is used.
previewdiff_idthe inline comments PreviewDiff ID context.
inline_commentsa dictionary containing the draft inline comments keyed by the diff line number.
def createCommentFromMessage(message, vote, review_type, original_email):
Create an ICodeReviewComment from an IMessage.
ParametersmessageThe IMessage to use.
voteA CodeReviewVote (or None).
review_typeA string (or None).
original_emailOriginal email message.
@export_read_operation()
@operation_parameters(Int())
@call_with(REQUEST_USER)
@operation_for_version('devel')
def getDraftInlineComments(previewdiff_id, person):
Return the draft inline comments related to this MP.

The return value is a dictionary (object) where the keys are the diff lines and their values are the actual draft comment created by the given person.

Parameterspreviewdiff_idThe ID of the target PreviewDiff.
personThe IPerson owner of the draft comments.
@export_write_operation()
@operation_parameters(Int(), Dict(TextLine(), Text()))
@call_with(REQUEST_USER)
@operation_for_version('devel')
def saveDraftInlineComment(previewdiff_id, person, comments):
Save ICodeReviewInlineCommentDraft
Parameterspreviewdiff_idThe ID of the target PreviewDiff.
personThe IPerson making the comments.
commentsThe comments.
@export_write_operation()
@operation_parameters(Reference(Interface))
@call_with(REQUEST_USER)
@operation_for_version('devel')
def linkBug(bug, user=None, check_permissions=True):
Link a bug to this merge proposal.
@export_write_operation()
@operation_parameters(Reference(Interface))
@call_with(REQUEST_USER)
@operation_for_version('devel')
def unlinkBug(bug, user=None, check_permissions=True):
Unlink a bug from this merge proposal.
API Documentation for Launchpad, generated by pydoctor at 2020-02-18 00:00:14.