BCFMarkup

class BCFMarkup()

Constructors


Constructors

BCFMarkup.constructor(filename, document, bcfTopic)
Arguments:
  • filename (string()) – None
  • document (Document | null()) – None
  • bcfTopic (BCFTopic()) – None
Return type:

BCFMarkup()

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:

BCFComment()

addViewpoint

BCFMarkup.addViewpoint(guid[, viewpointFilename[, snapshotFilename[, index]]])
Arguments:
  • guid (Uuid) – None
  • viewpointFilename (string()) – optional None
  • snapshotFilename (string()) – optional None
  • index (string()) – optional None
Return type:

void

deleteComment

BCFMarkup.deleteComment(guid)
Arguments:
Return type:

void

export

BCFMarkup.export()
Return type:XMLDocument

getComments

BCFMarkup.getComments()
Return type:Map <Uuid, BCFComment()>

getFilename

BCFMarkup.getFilename()
Return type:string

getMarkupHeaderFiles

BCFMarkup.getMarkupHeaderFiles()
Return type:[BCFMarkupHeaderFile()]

getProjectGuid

BCFMarkup.getProjectGuid()
Return type:Uuid | null

getTopicAssignedTo

BCFMarkup.getTopicAssignedTo()
Return type:string | null

getTopicCreationAuthor

BCFMarkup.getTopicCreationAuthor()
Return type:string

getTopicCreationDate

BCFMarkup.getTopicCreationDate()
Return type:Date

getTopicDescription

BCFMarkup.getTopicDescription()
Return type:string | null

getTopicDueDate

BCFMarkup.getTopicDueDate()
Return type:Date | null

getTopicId

BCFMarkup.getTopicId()
Return type:Uuid

getTopicIndex

BCFMarkup.getTopicIndex()
Return type:number | null

getTopicLabels

BCFMarkup.getTopicLabels()
Return type:[string]

getTopicModifiedAuthor

BCFMarkup.getTopicModifiedAuthor()
Return type:string | null

getTopicModifiedDate

BCFMarkup.getTopicModifiedDate()
Return type:Date | null

getTopicPriority

BCFMarkup.getTopicPriority()
Return type:string | null

getTopicStage

BCFMarkup.getTopicStage()
Return type:string | null

getTopicStatus

BCFMarkup.getTopicStatus()
Return type:string | null

getTopicTitle

BCFMarkup.getTopicTitle()
Return type:string

getTopicType

BCFMarkup.getTopicType()
Return type:string | null

getViewpoints

BCFMarkup.getViewpoints()
Return type:Map <Uuid, BCFMarkupViewpoint()>

setTopicAssignedTo

BCFMarkup.setTopicAssignedTo(assignedTo)
Arguments:
  • assignedTo (string | null()) – None
Return type:

void

setTopicCreationAuthor

BCFMarkup.setTopicCreationAuthor(author)
Arguments:
  • author (string()) –
Return type:

void

setTopicCreationDate

BCFMarkup.setTopicCreationDate(date)
Arguments:
  • date (Date()) –
Return type:

void

setTopicDescription

BCFMarkup.setTopicDescription(description)
Arguments:
  • description (string | null()) –
Return type:

void

setTopicDueDate

BCFMarkup.setTopicDueDate(date)
Arguments:
  • date (Date | null()) –
Return type:

void

setTopicId

BCFMarkup.setTopicId(guid)
Arguments:
Return type:

void

setTopicIndex

BCFMarkup.setTopicIndex(index)
Arguments:
  • index (number | null()) –
Return type:

void

setTopicLabels

BCFMarkup.setTopicLabels(labels)
Arguments:
  • labels ([string]()) –
Return type:

void

setTopicModifiedAuthor

BCFMarkup.setTopicModifiedAuthor(modifiedAuthor)
Arguments:
  • modifiedAuthor (string | null()) –
Return type:

void

setTopicModifiedDate

BCFMarkup.setTopicModifiedDate(date)
Arguments:
  • date (Date | null()) –
Return type:

void

setTopicPriority

BCFMarkup.setTopicPriority(priority)
Arguments:
  • priority (string | null()) –
Return type:

void

setTopicState

BCFMarkup.setTopicState(stage)
Arguments:
  • stage (string | null()) –
Return type:

void

setTopicStatus

BCFMarkup.setTopicStatus(topicStatus)
Arguments:
  • topicStatus (string | null()) –
Return type:

void

setTopicTitle

BCFMarkup.setTopicTitle(title)
Arguments:
  • title (string()) –
Return type:

void

setTopicType

BCFMarkup.setTopicType(topicType)
Arguments:
  • topicType (string | null()) –
Return type:

void

updateComment

BCFMarkup.updateComment(comment)
Arguments:
Return type:

void