Class BAttachment

Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for larger amounts of data and generally not accessible to the user.

Hierarchy (View Summary)

AbstractBeccaEntity<BAttachment>
- BAttachment

Constructors

constructor

new BAttachment(row: AttachmentRow): BAttachment
Parameters
- row: AttachmentRow
Returns BAttachment
Overrides AbstractBeccaEntity.constructor
- Defined in src/becca/entities/battachment.ts:58

Properties

`Optional`attachmentId

attachmentId?: string

`Optional`blobId

blobId?: string

`Optional`contentLength

contentLength?: number

optionally added to the entity

`Optional`dateCreated

dateCreated?: string

`Optional`dateModified

dateModified?: string

`Optional`isDecrypted

isDecrypted?: boolean

`Optional`isProtected

isProtected?: boolean

`Optional`isSynced

isSynced?: boolean

mime

mime: string

`Optional`noteId

noteId?: number

ownerId

ownerId: string

either noteId or revisionId to which this attachment belongs

`Optional`position

position?: number

role

role: string

title

title: string

`Optional`type

type?: "image" | "file"

utcDateCreated

utcDateCreated: string

`Optional`utcDateModified

utcDateModified?: string

`Optional`utcDateScheduledForErasureSince

utcDateScheduledForErasureSince?: null | string

Accessors

`Protected`becca

get becca(): default
Returns default
Inherited from AbstractBeccaEntity.becca
- Defined in src/becca/entities/abstract_becca_entity.ts:47

isDeleted

get isDeleted(): boolean
Returns boolean
Inherited from AbstractBeccaEntity.isDeleted
- Defined in src/becca/entities/abstract_becca_entity.ts:95

`Static`entityName

get entityName(): string
Returns string
- Defined in src/becca/entities/battachment.ts:34

`Static`hashedProperties

get hashedProperties(): string[]
Returns string[]
- Defined in src/becca/entities/battachment.ts:40

`Static`primaryKeyName

get primaryKeyName(): string
Returns string
- Defined in src/becca/entities/battachment.ts:37

Methods

`Protected`_getContent

_getContent(): string | Buffer<ArrayBufferLike>
Returns string | Buffer<ArrayBufferLike>
Inherited from AbstractBeccaEntity._getContent
- Defined in src/becca/entities/abstract_becca_entity.ts:261

`Protected`_setContent

_setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void
Parameters
- content: string | Buffer<ArrayBufferLike>
- opts: ContentOpts = {}
Returns void
Inherited from AbstractBeccaEntity._setContent
- Defined in src/becca/entities/abstract_becca_entity.ts:140

beforeSaving

beforeSaving(): void
Returns void
Overrides AbstractBeccaEntity.beforeSaving
- Defined in src/becca/entities/battachment.ts:206

convertToNote

convertToNote(): { branch: BBranch; note: BNote }
Returns { branch: BBranch; note: BNote }
- Defined in src/becca/entities/battachment.ts:146

copy

copy(): BAttachment
Returns BAttachment
- Defined in src/becca/entities/battachment.ts:90

decrypt

decrypt(): void
Returns void
- Defined in src/becca/entities/battachment.ts:122

generateHash

generateHash(isDeleted?: boolean): string
Parameters
- OptionalisDeleted: boolean
Returns string
Inherited from AbstractBeccaEntity.generateHash
- Defined in src/becca/entities/abstract_becca_entity.ts:63

getContent

getContent(): Buffer
Returns Buffer
- Defined in src/becca/entities/battachment.ts:138

getFileName

getFileName(): string
Returns string
- Defined in src/becca/entities/battachment.ts:200

getNote

getNote(): BNote
Returns BNote
- Defined in src/becca/entities/battachment.ts:101

getPojo

getPojo(): {
    attachmentId: undefined
    | string;
    blobId: undefined | string;
    contentLength: undefined | number;
    dateModified: undefined | string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    ownerId: string;
    position: undefined | number;
    role: string;
    title: undefined | string;
    utcDateModified: undefined | string;
    utcDateScheduledForErasureSince: undefined | null | string;
}
Returns {
    attachmentId: undefined | string;
    blobId: undefined | string;
    contentLength: undefined | number;
    dateModified: undefined | string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    ownerId: string;
    position: undefined | number;
    role: string;
    title: undefined | string;
    utcDateModified: undefined | string;
    utcDateScheduledForErasureSince: undefined | null | string;
}
Overrides AbstractBeccaEntity.getPojo
- Defined in src/becca/entities/battachment.ts:224

getPojoToSave

getPojoToSave(): {
    attachmentId: undefined
    | string;
    blobId: undefined | string;
    contentLength: undefined | number;
    dateModified: undefined | string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    ownerId: string;
    position: undefined | number;
    role: string;
    title: undefined | string;
    utcDateModified: undefined | string;
    utcDateScheduledForErasureSince: undefined | null | string;
}
Returns {
    attachmentId: undefined | string;
    blobId: undefined | string;
    contentLength: undefined | number;
    dateModified: undefined | string;
    isDeleted: boolean;
    isProtected: boolean;
    mime: string;
    ownerId: string;
    position: undefined | number;
    role: string;
    title: undefined | string;
    utcDateModified: undefined | string;
    utcDateScheduledForErasureSince: undefined | null | string;
}
Overrides AbstractBeccaEntity.getPojoToSave
- Defined in src/becca/entities/battachment.ts:242

getTitleOrProtected

getTitleOrProtected(): string
Returns string
- Defined in src/becca/entities/battachment.ts:118

getUtcDateChanged

getUtcDateChanged(): string
Returns string
Inherited from AbstractBeccaEntity.getUtcDateChanged
- Defined in src/becca/entities/abstract_becca_entity.ts:43

hasStringContent

hasStringContent(): boolean
Returns boolean
true if the note has string content (not binary)
Overrides AbstractBeccaEntity.hasStringContent
- Defined in src/becca/entities/battachment.ts:106

init

init(): void
Returns void
Inherited from AbstractBeccaEntity.init
- Defined in src/becca/entities/abstract_becca_entity.ts:89

isContentAvailable

isContentAvailable(): boolean
Returns boolean
- Defined in src/becca/entities/battachment.ts:110

markAsDeleted

markAsDeleted(deleteId?: null | string): void
Mark the entity as (soft) deleted. It will be completely erased later.

This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.
Parameters
- deleteId: null | string = null
Returns void
Inherited from AbstractBeccaEntity.markAsDeleted
- Defined in src/becca/entities/abstract_becca_entity.ts:277

markAsDeletedSimple

markAsDeletedSimple(): void
Returns void
Inherited from AbstractBeccaEntity.markAsDeletedSimple
- Defined in src/becca/entities/abstract_becca_entity.ts:303

`Protected`putEntityChange

putEntityChange(isDeleted: boolean): void
Parameters
- isDeleted: boolean
Returns void
Inherited from AbstractBeccaEntity.putEntityChange
- Defined in src/becca/entities/abstract_becca_entity.ts:51

save

save(opts?: {}): this
Saves entity - executes SQL, but doesn't commit the transaction on its own
Parameters
- Optionalopts: {}
Returns this
Inherited from AbstractBeccaEntity.save
- Defined in src/becca/entities/abstract_becca_entity.ts:103

setContent

setContent(content: string | Buffer<ArrayBufferLike>, opts?: ContentOpts): void
Parameters
- content: string | Buffer<ArrayBufferLike>
- Optionalopts: ContentOpts
Returns void
- Defined in src/becca/entities/battachment.ts:142

updateFromRow

updateFromRow(row: AttachmentRow): void
Parameters
- row: AttachmentRow
Returns void
Overrides AbstractBeccaEntity.updateFromRow
- Defined in src/becca/entities/battachment.ts:65

Class BAttachment

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BAttachment

Properties

OptionalattachmentId

OptionalblobId

OptionalcontentLength

OptionaldateCreated

OptionaldateModified

OptionalisDecrypted

OptionalisProtected

OptionalisSynced

mime

OptionalnoteId

ownerId

Optionalposition

role

title

Optionaltype

utcDateCreated

OptionalutcDateModified

OptionalutcDateScheduledForErasureSince

Accessors

Protectedbecca

Returns default

isDeleted

Returns boolean

StaticentityName

Returns string

StatichashedProperties

Returns string[]

StaticprimaryKeyName

Returns string

Methods

Protected_getContent

Returns string | Buffer<ArrayBufferLike>

Protected_setContent

Parameters

Returns void

beforeSaving

Returns void

convertToNote

Returns { branch: BBranch; note: BNote }

copy

Returns BAttachment

decrypt

Returns void

generateHash

Parameters

Returns string

getContent

Returns Buffer

getFileName

Returns string

getNote

Returns BNote

getPojo

getPojoToSave

getTitleOrProtected

Returns string

getUtcDateChanged

Returns string

hasStringContent

Returns boolean

init

Returns void

isContentAvailable

Returns boolean

markAsDeleted

Parameters

Returns void

markAsDeletedSimple

`Optional`attachmentId

`Optional`blobId

`Optional`contentLength

`Optional`dateCreated

`Optional`dateModified

`Optional`isDecrypted

`Optional`isProtected

`Optional`isSynced

`Optional`noteId

`Optional`position

`Optional`type

`Optional`utcDateModified

`Optional`utcDateScheduledForErasureSince

`Protected`becca

`Static`entityName

`Static`hashedProperties

`Static`primaryKeyName

`Protected`_getContent

`Protected`_setContent

`Protected`putEntityChange