Class BEtapiToken

EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications. Used by:

Trilium Sender
ETAPI clients

The format user is presented with is "_". This is also called "authToken" to distinguish it from tokenHash and token.

Hierarchy (View Summary)

AbstractBeccaEntity<BEtapiToken>
- BEtapiToken

Constructors

constructor

new BEtapiToken(row?: EtapiTokenRow): BEtapiToken
Parameters
- Optionalrow: EtapiTokenRow
Returns BEtapiToken
Overrides AbstractBeccaEntity.constructor
- Defined in src/becca/entities/betapi_token.ts:33

Properties

`Optional`blobId

blobId?: string

`Optional`dateCreated

dateCreated?: string

`Optional`dateModified

dateModified?: string

`Optional`etapiTokenId

etapiTokenId?: string

`Optional`isProtected

isProtected?: boolean

`Optional`isSynced

isSynced?: boolean

name

name: string

tokenHash

tokenHash: string

utcDateCreated

utcDateCreated: string

`Optional`utcDateModified

utcDateModified?: 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
Overrides AbstractBeccaEntity.isDeleted
- Defined in src/becca/entities/betapi_token.ts:44

`Static`entityName

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

`Static`hashedProperties

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

`Static`primaryKeyName

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

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/betapi_token.ts:78

generateHash

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

getPojo

getPojo(): {
    etapiTokenId: undefined
    | string;
    isDeleted: boolean;
    name: string;
    tokenHash: string;
    utcDateCreated: string;
    utcDateModified: undefined | string;
}
Returns {
    etapiTokenId: undefined | string;
    isDeleted: boolean;
    name: string;
    tokenHash: string;
    utcDateCreated: string;
    utcDateModified: undefined | string;
}
Overrides AbstractBeccaEntity.getPojo
- Defined in src/becca/entities/betapi_token.ts:67

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

updateFromRow

updateFromRow(row: EtapiTokenRow): void
Parameters
- row: EtapiTokenRow
Returns void
Overrides AbstractBeccaEntity.updateFromRow
- Defined in src/becca/entities/betapi_token.ts:48

Class BEtapiToken

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BEtapiToken

Properties

OptionalblobId

OptionaldateCreated

OptionaldateModified

OptionaletapiTokenId

OptionalisProtected

OptionalisSynced

name

tokenHash

utcDateCreated

OptionalutcDateModified

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

generateHash

Parameters

Returns string

getPojo

Returns { etapiTokenId: undefined | string; isDeleted: boolean; name: string; tokenHash: string; utcDateCreated: string; utcDateModified: undefined | string;}

ProtectedgetPojoToSave

Returns {}

getUtcDateChanged

Returns string

hasStringContent

Returns boolean

init

Returns void

markAsDeleted

Parameters

Returns void

markAsDeletedSimple

Returns void

ProtectedputEntityChange

Parameters

Returns void

save

Parameters

Returns this

updateFromRow

Parameters

Returns void

Settings

On This Page

`Optional`blobId

`Optional`dateCreated

`Optional`dateModified

`Optional`etapiTokenId

`Optional`isProtected

`Optional`isSynced

`Optional`utcDateModified

`Protected`becca

`Static`entityName

`Static`hashedProperties

`Static`primaryKeyName

`Protected`_getContent

`Protected`_setContent

Returns {
etapiTokenId: undefined | string;
isDeleted: boolean;
name: string;
tokenHash: string;
utcDateCreated: string;
utcDateModified: undefined | string;
}

`Protected`getPojoToSave

`Protected`putEntityChange