BCFMarkup
-
class
BCFMarkup
()
Constructors
Methods
addComment()
addViewpoint()
deleteComment()
export()
getComments()
getFilename()
getMarkupHeaderFiles()
getProjectGuid()
getTopicAssignedTo()
getTopicCreationAuthor()
getTopicCreationDate()
getTopicDescription()
getTopicDueDate()
getTopicId()
getTopicIndex()
getTopicLabels()
getTopicModifiedAuthor()
getTopicModifiedDate()
getTopicPriority()
getTopicReferenceLink()
getTopicStage()
getTopicStatus()
getTopicTitle()
getTopicType()
getViewpoints()
setTopicAssignedTo()
setTopicCreationAuthor()
setTopicCreationDate()
setTopicDescription()
setTopicDueDate()
setTopicId()
setTopicIndex()
setTopicLabels()
setTopicModifiedAuthor()
setTopicModifiedDate()
setTopicPriority()
setTopicReferenceLink()
setTopicState()
setTopicStatus()
setTopicTitle()
setTopicType()
updateComment()
Constructors
-
BCFMarkup.
constructor
(filename, document, bcfTopic) Arguments: - filename (
string()
) – None - document (
Document | null()
) – None - bcfTopic (
BCFTopic()
) – None
Return type: - filename (
Methods
addComment
-
BCFMarkup.
addComment
(date, author, text[, viewpointGuid[, modifiedDate[, modifiedAuthor]]]) Arguments: - date (
Date()
) – - author (
string()
) – - text (
string()
) – - viewpointGuid (
string()
) – optional - modifiedDate (
Date()
) – optional - modifiedAuthor (
string()
) – optional
Return type: - date (
addViewpoint
getComments
-
BCFMarkup.
getComments
() Return type: Map <Uuid, BCFComment()
>
getMarkupHeaderFiles
-
BCFMarkup.
getMarkupHeaderFiles
() Return type: [ BCFMarkupHeaderFile()
]
getViewpoints
-
BCFMarkup.
getViewpoints
() Return type: Map <Uuid, BCFMarkupViewpoint()
>
setTopicAssignedTo
-
BCFMarkup.
setTopicAssignedTo
(assignedTo) Arguments: - assignedTo (
string | null()
) – None
Return type: void
- assignedTo (
setTopicCreationAuthor
-
BCFMarkup.
setTopicCreationAuthor
(author) Arguments: - author (
string()
) –
Return type: void
- author (
setTopicCreationDate
-
BCFMarkup.
setTopicCreationDate
(date) Arguments: - date (
Date()
) –
Return type: void
- date (
setTopicDescription
-
BCFMarkup.
setTopicDescription
(description) Arguments: - description (
string | null()
) –
Return type: void
- description (
setTopicDueDate
-
BCFMarkup.
setTopicDueDate
(date) Arguments: - date (
Date | null()
) –
Return type: void
- date (
setTopicIndex
-
BCFMarkup.
setTopicIndex
(index) Arguments: - index (
number | null()
) –
Return type: void
- index (
setTopicModifiedAuthor
-
BCFMarkup.
setTopicModifiedAuthor
(modifiedAuthor) Arguments: - modifiedAuthor (
string | null()
) –
Return type: void
- modifiedAuthor (
setTopicModifiedDate
-
BCFMarkup.
setTopicModifiedDate
(date) Arguments: - date (
Date | null()
) –
Return type: void
- date (
setTopicPriority
-
BCFMarkup.
setTopicPriority
(priority) Arguments: - priority (
string | null()
) –
Return type: void
- priority (
setTopicReferenceLink
-
BCFMarkup.
setTopicReferenceLink
(referenceLink) Arguments: - referenceLink (
string | null()
) –
Return type: void
- referenceLink (
setTopicState
-
BCFMarkup.
setTopicState
(stage) Arguments: - stage (
string | null()
) –
Return type: void
- stage (
setTopicStatus
-
BCFMarkup.
setTopicStatus
(topicStatus) Arguments: - topicStatus (
string | null()
) –
Return type: void
- topicStatus (
setTopicType
-
BCFMarkup.
setTopicType
(topicType) Arguments: - topicType (
string | null()
) –
Return type: void
- topicType (
updateComment
-
BCFMarkup.
updateComment
(comment) Arguments: - comment (
BCFComment()
) –
Return type: void
- comment (