lp.code.interfaces.codereviewinlinecomment.ICodeReviewInlineCommentSet : API documentation

Method	ensureDraft	Ensure a `ICodeReviewInlineCommentDraft` is up to date. This method
Method	publishDraft	Publish code review inline comments so other people can view them.
Method	getDraft	Return the draft comments for a given diff and person.
Method	getPublished	Return published comments for a given `PreviewDiff`.
Method	getByReviewComment	Return published comments for a given `CodeReviewComment`.
Method	getPreviewDiffsForComments	Return a dictionary container related comments and diffs.
Method	removeFromDiffs	Remove inline comments for the given `PreviewDiff` ids.

def ensureDraft(previewdiff, person, comments):

Ensure a ICodeReviewInlineCommentDraft is up to date. This method will also delete an existing draft if the comments are empty.

Parameters	previewdiff	The `PreviewDiff` these comments are for.
	person	The `Person` making the comments.
	comments	The comments themselves.

def publishDraft(previewdiff, person, comment):

Publish code review inline comments so other people can view them.

Parameters	previewdiff	The `PreviewDiff` these comments are for.
	person	The `Person` making the comments.
	comment	The `CodeReviewComment` linked to the comments.

def getDraft(previewdiff, person):

Return the draft comments for a given diff and person.

Parameters	previewdiff	The `PreviewDiff` these comments are for.
	person	The `Person` making the comments.

def getPublished(previewdiff):

Return published comments for a given PreviewDiff.

Parameters previewdiff The PreviewDiff these comments are for.

def getByReviewComment(comment):

Return published comments for a given CodeReviewComment.

Parameters comment The CodeReviewComment for linked to the inline comments.

def getPreviewDiffsForComments(comments):

Return a dictionary container related comments and diffs.

Used for prepopulating `BranchMergeProposal` view caches.
`CodeReviewComment` and `PreviewDiff` are related by the existence
of `CodeReviewInlineComment`.

:param comments: a list of `CodeReviewComment`s
:return: a dictionary containing the given `CodeReviewComment.id`s
    and the corresponding `PreviewDiff.id` or None.

def removeFromDiffs(previewdiff_ids):

Remove inline comments for the given PreviewDiff ids.

Remove CodeReviewInlineComment`s and `CodeReviewInlineCommentDraft`s associated with a given list of `PreviewDiff IDs.

Parameters comments a list of PreviewDiff IDs.

l.c.i.c.ICodeReviewInlineCommentSet(Interface) : interface documentation