Skip to main content

Class: PinnedItem

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

Pinned item in a collection

Constructors​

Constructor​

new PinnedItem(data): PinnedItem

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

Parameters​

data​
collectionId?​

number

createdDate?​

string

itemType​

"commentary" | "verse" | "passage" | "note" | "dictionary_entry" | "book_section" | "image"

metadata?​

Metadata

moduleId?​

number

notes?​

string

pinId?​

number

referenceId?​

number

referenceText?​

string

sortOrder?​

number

title?​

string

verseIdEnd?​

number

verseIdStart?​

number

Returns​

PinnedItem

Properties​

collectionId?​

optional collectionId?: number

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

createdDate?​

optional createdDate?: string

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

itemType​

itemType: "commentary" | "verse" | "passage" | "note" | "dictionary_entry" | "book_section" | "image"

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

metadata?​

optional metadata?: Metadata

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

moduleId?​

optional moduleId?: number

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

notes?​

optional notes?: string

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

pinId?​

optional pinId?: number

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

referenceId?​

optional referenceId?: number

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

referenceText?​

optional referenceText?: string

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

sortOrder​

sortOrder: number

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

title?​

optional title?: string

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

verseIdEnd?​

optional verseIdEnd?: number

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

verseIdStart?​

optional verseIdStart?: number

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

Methods​

isVersePinType()​

isVersePinType(): boolean

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

Check if this is a verse or passage pin

Returns​

boolean

isVerseRange()​

isVerseRange(): boolean

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

Check if this is a verse range

Returns​

boolean