Skip to content

Bookmark

Bookmark(subsonic, entry, position, username=None, created=None, changed=None, comment=None)

Bases: Model

Object that holds all the info about a bookmark.

Attributes:

Name Type Description
song Song

All the info about the bookmarked song.
position int

The position in seconds of the playback of the song when it was bookmarked.
user User | None

All the info about the user that created the bookmark.
comment str | None

A comment attached to the bookmark.
created datetime | None

The timestamp when the bookmark was created.
changed datetime | None

The timestamp when the bookmark was updated.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_bookmark.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def __init__(
    self,
    subsonic: "Subsonic",
    entry: dict[str, Any],
    position: int,
    username: str | None = None,
    created: str | None = None,
    changed: str | None = None,
    comment: str | None = None,
) -> None:
    super().__init__(subsonic)

    self.song = Song(self._subsonic, **entry)
    self.position = position
    self.user = (
        User(subsonic=self._subsonic, username=username) if username else None
    )
    self.comment = comment
    self.created = parser.parse(created) if created else None
    self.changed = parser.parse(changed) if changed else None

create()

Create a new bookmark for the authenticated user with the same data of the object where this method is called.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_bookmark.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def create(self) -> Self:
    """Create a new bookmark for the authenticated user
    with the same data of the object where this method is
    called.

    Returns:
        The object itself.
    """

    self._subsonic.bookmarks.create_bookmark(
        self.song.id, self.position, self.comment
    )

    return self

delete()

Delete the bookmark entry from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_bookmark.py 
 98
 99
100
101
102
103
104
105
106
107
def delete(self) -> Self:
    """Delete the bookmark entry from the server.

    Returns:
        The object itself.
    """

    self._subsonic.bookmarks.delete_bookmark(self.song.id)

    return self

generate()

Return a new album object with all the data updated from the API, using the endpoint that return the most information possible.

Useful for making copies with updated data or updating the object itself with immutability, e.g., foo = foo.generate().

Returns:

Type Description
Bookmark

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_bookmark.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def generate(self) -> "Bookmark":
    """Return a new album object with all the data updated from the API,
    using the endpoint that return the most information possible.

    Useful for making copies with updated data or updating the object
    itself with immutability, e.g., `foo = foo.generate()`.

    Returns:
        A new object with all the updated info.
    """

    get_bookmark = self._subsonic.bookmarks.get_bookmark(self.song.id)

    if get_bookmark is None:
        raise ResourceNotFound()

    return get_bookmark

update()

Update the info about the bookmark of this song using the current data of the object.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_bookmark.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
def update(self) -> Self:
    """Update the info about the bookmark of this song using the
    current data of the object.

    Returns:
        The object itself.
    """

    self._subsonic.bookmarks.update_bookmark(
        self.song.id, self.position, self.comment
    )

    return self