Skip to main content

Class: UserCommentary

Defined in: Data/Models/User/UserCommentary.ts:9

User commentary collection entity from the user database. Represents a prayer list or note collection container — groups related UserNote entries together. This is distinct from UserNote, which holds individual note content; UserCommentary is the organizational parent.

Constructors​

Constructor​

new UserCommentary(data): UserCommentary

Defined in: Data/Models/User/UserCommentary.ts:19

Parameters​

data​
color?​

string

createdDate?​

string

description?​

string

isDefault?​

boolean

metadata?​

Metadata

modifiedDate?​

string

name​

string

userCommentaryId?​

number

Returns​

UserCommentary

Properties​

color?​

optional color?: string

Defined in: Data/Models/User/UserCommentary.ts:16

createdDate?​

optional createdDate?: string

Defined in: Data/Models/User/UserCommentary.ts:13

description?​

optional description?: string

Defined in: Data/Models/User/UserCommentary.ts:12

isDefault​

isDefault: boolean

Defined in: Data/Models/User/UserCommentary.ts:15

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/User/UserCommentary.ts:17

modifiedDate?​

optional modifiedDate?: string

Defined in: Data/Models/User/UserCommentary.ts:14

name​

name: string

Defined in: Data/Models/User/UserCommentary.ts:11

userCommentaryId?​

optional userCommentaryId?: number

Defined in: Data/Models/User/UserCommentary.ts:10

Methods​

isDefaultCommentary()​

isDefaultCommentary(): boolean

Defined in: Data/Models/User/UserCommentary.ts:49

Check if this is the default commentary

Returns​

boolean

touch()​

touch(): void

Defined in: Data/Models/User/UserCommentary.ts:42

Update the modified date to now

Returns​

void