Skip to main content

@bloock/sdk / RecordBuilder

Class: RecordBuilder

Assists in constructing records with various configurations.

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new RecordBuilder(payload, payloadType, configData): RecordBuilder

Creates a new RecordBuilder with default configuration.

Parameters​

NameType
payloadany
payloadTypeRecordTypes
configDataConfigData

Returns​

RecordBuilder

Defined in​

client/record.ts:123

Properties​

configData​

• configData: ConfigData

Defined in​

client/record.ts:115


decrypter​

• decrypter: undefined | Encrypter

Defined in​

client/record.ts:113


encrypter​

• encrypter: undefined | Encrypter

Defined in​

client/record.ts:112


payload​

• payload: any

Defined in​

client/record.ts:109


payloadType​

• payloadType: RecordTypes

Defined in​

client/record.ts:110


signer​

• signer: undefined | Signer

Defined in​

client/record.ts:111

Methods​

build​

▸ build(): Promise<Record>

Constructs a record based on the RecordBuilder's configuration.

Returns​

Promise<Record>

Defined in​

client/record.ts:163


getDetails​

▸ getDetails(): Promise<RecordDetails>

Gets details about other Bloock services (Integrity, Authenticity, Encryption, Availability) configured in the RecordBuilder.

Returns​

Promise<RecordDetails>

Defined in​

client/record.ts:307


withDecrypter​

▸ withDecrypter(decrypter): RecordBuilder

Sets the decrypter for the RecordBuilder.

Parameters​

NameType
decrypterEncrypter

Returns​

RecordBuilder

Defined in​

client/record.ts:154


withEncrypter​

▸ withEncrypter(encrypter): RecordBuilder

Sets the encrypter for the RecordBuilder.

Parameters​

NameType
encrypterEncrypter

Returns​

RecordBuilder

Defined in​

client/record.ts:144


withSigner​

▸ withSigner(signer): RecordBuilder

Sets the signer for the RecordBuilder.

Parameters​

NameType
signerSigner

Returns​

RecordBuilder

Defined in​

client/record.ts:134