Skip to main content

Class: Collection

Defined in: Data/Models/User/Collection.ts:7

Collection entity from the user database Represents a user-created collection for organizing study materials

Constructors​

Constructor​

new Collection(data): Collection

Defined in: Data/Models/User/Collection.ts:25

Parameters​

data​
collectionId?​

number

color?​

string

createdDate?​

string

description?​

string

icon?​

string

metadata?​

Metadata

modifiedDate?​

string

name​

string

parentCollectionId?​

number

sortOrder?​

number

Returns​

Collection

Properties​

collectionId?​

optional collectionId?: number

Defined in: Data/Models/User/Collection.ts:8

color?​

optional color?: string

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

createdDate?​

optional createdDate?: string

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

description?​

optional description?: string

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

icon?​

optional icon?: string

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

metadata?​

optional metadata?: Metadata

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

modifiedDate?​

optional modifiedDate?: string

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

name​

name: string

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

parentCollectionId?​

optional parentCollectionId?: number

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

sortOrder​

sortOrder: number

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

Methods​

addChild()​

addChild(collection): void

Defined in: Data/Models/User/Collection.ts:73

Add a child collection

Parameters​

collection​

Collection

Returns​

void

addPinnedItem()​

addPinnedItem(item): void

Defined in: Data/Models/User/Collection.ts:100

Add a pinned item

Parameters​

item​

PinnedItem

Returns​

void

getChildren()​

getChildren(): Collection[]

Defined in: Data/Models/User/Collection.ts:66

Get child collections

Returns​

Collection[]

getItemCount()​

getItemCount(): number

Defined in: Data/Models/User/Collection.ts:127

Get item count

Returns​

number

getPinnedItems()​

getPinnedItems(): PinnedItem[]

Defined in: Data/Models/User/Collection.ts:93

Get pinned items

Returns​

PinnedItem[]

hasChildren()​

hasChildren(): boolean

Defined in: Data/Models/User/Collection.ts:59

Check if this collection has child collections

Returns​

boolean

isTopLevel()​

isTopLevel(): boolean

Defined in: Data/Models/User/Collection.ts:52

Check if this is a top-level collection

Returns​

boolean

removeChild()​

removeChild(collectionId): boolean

Defined in: Data/Models/User/Collection.ts:81

Remove a child collection

Parameters​

collectionId​

number

Returns​

boolean

removePinnedItem()​

removePinnedItem(pinId): boolean

Defined in: Data/Models/User/Collection.ts:108

Remove a pinned item

Parameters​

pinId​

number

Returns​

boolean

setPinnedItems()​

setPinnedItems(items): void

Defined in: Data/Models/User/Collection.ts:120

Set all pinned items (from repository query)

Parameters​

items​

PinnedItem[]

Returns​

void

touch()​

touch(): void

Defined in: Data/Models/User/Collection.ts:134

Update the modified date to now

Returns​

void