api.bookmarks

Interface: IBookmarksApi

Implementation tier: T1

Manage verse bookmarks and bookmark collections.

Permissions

• bookmarks:read
• bookmarks:write (for add/remove/createCollection)

Methods

list

list(collectionId?: string): Promise<BookmarkDto[]>

Parameters:

Name	Type	Required	Description
collectionId	string	No

Returns: Promise<BookmarkDto[]>

---

add

add(verseId: number, collectionId?: string): Promise<BookmarkDto>

Parameters:

Name	Type	Required	Description
verseId	number	Yes
collectionId	string	No

Returns: Promise<BookmarkDto>

---

remove

remove(id: string): Promise<void>

Parameters:

Name	Type	Required	Description
id	string	Yes

Returns: Promise<void>

---

listCollections

listCollections(): Promise<CollectionDto[]>

Returns: Promise<CollectionDto[]>

---

createCollection

createCollection(name: LocalizedString): Promise<CollectionDto>

Parameters:

Name	Type	Required	Description
name	LocalizedString	Yes

Returns: Promise<CollectionDto>

---