BCFData

class Communicator.BCFData(): This class contains data corresponding to the BCF file format.

Constructors

constructor()

Methods

addTopic()
exportBCF()
getFilename()
getId()
getTopic()
getTopics()
getVersion()
setVersion()
toBcfZipBlob()

Constructors

BCFData.constructor(bcfFileName, id)

Arguments

bcfFileName (BCFName) –
id (number()) –

Return type

BCFData()

Methods

addTopic

BCFData.addTopic(topicId, topic)

Adds a BCF topic.

Arguments

topicId (BCFTopicId) –
topic (BCFTopic()) –

Return type

void

exportBCF

BCFData.exportBCF(filename)

Exports BCF data to a file. Prompts the user to save it on their device.

Arguments

filename (BCFName) – Filename BCF data will be exported as

Return type

Promise <void>

getFilename

BCFData.getFilename()

Gets the BCF filename.

Return type: BCFName

getId

BCFData.getId()

Identifier used to keep track of loaded BCF data.

Return type: number

getTopic

BCFData.getTopic(topicId)

Gets a BCF topic.

Arguments

topicId (BCFTopicId) –

Return type

BCFTopic() | null

getTopics

BCFData.getTopics()

Return type: Map <BCFTopicId, BCFTopic()>
Returns: A map associating BCF topic ids to BCF topic data.

getVersion

BCFData.getVersion()

Gets the BCF version.

Return type: BCFVersion

setVersion

BCFData.setVersion(version)

Sets the BCF version.

Arguments

version (BCFVersion) –

Return type

void

toBcfZipBlob

BCFData.toBcfZipBlob()

Creates a BCFZIP blob. The resulting blob is importable using BcfManager.addBCFFromBuffer.

Return type: Promise <Blob>