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

constructor

Communicator.BCFData.constructor(bcfFileName, id)

Arguments

bcfFileName (Communicator.BCFName()) –
id (number()) –

Return type

Communicator.BCFData

Methods

addTopic

Communicator.BCFData.addTopic(topicId, topic)

Adds a BCF topic.

Arguments

topicId (Communicator.BCFTopicId()) –
topic (Communicator.BCFTopic()) –

Return type

void

exportBCF

Communicator.BCFData.exportBCF(filename)

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

Arguments

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

Return type

Promise[void]

getFilename

Communicator.BCFData.getFilename()

Gets the BCF filename.

Return type: Communicator.BCFName

getId

Communicator.BCFData.getId()

Identifier used to keep track of loaded BCF data.

Return type: number

getTopic

Communicator.BCFData.getTopic(topicId)

Gets a BCF topic.

Arguments

topicId (Communicator.BCFTopicId()) –

Return type

{ }

getTopics

Communicator.BCFData.getTopics()

Return type: Map[Communicator.BCFTopicId, Communicator.BCFTopic]
Returns: A map associating BCF topic ids to BCF topic data.

getVersion

Communicator.BCFData.getVersion()

Gets the BCF version.

Return type: Communicator.BCFVersion

setVersion

Communicator.BCFData.setVersion(version)

Sets the BCF version.

Arguments

version (Communicator.BCFVersion()) –

Return type

void

toBcfZipBlob

Communicator.BCFData.toBcfZipBlob()

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

Return type: Promise[Blob]