Collection

A named group of bookmarks. Collections can be manual (user adds bookmarks explicitly) or smart (bookmarks are included automatically based on a filter rule).

Attributes

Attribute	Type	Description
name	string	Display name.
collection_type	[CollectionType](collectiontype.md?sid=app_models_collection_collectiontype) = CollectionType.MANUAL	Whether the collection is manual or smart.
bookmark_ids	list of strings = []	Ordered list of bookmark IDs in the collection.
filter_rule	string	For smart collections, a query string that selects bookmarks.
is_pinned	boolean = false	Whether the collection appears at the top of the sidebar.
id	string	Unique identifier.
created_at	datetime	Creation timestamp.

---

Constructor

Signature

def Collection(
    name: str,
    collection_type: [CollectionType](collectiontype.md?sid=app_models_collection_collectiontype) = CollectionType.MANUAL,
    bookmark_ids: List[str] = [],
    filter_rule: str = "",
    is_pinned: bool = False,
    id: str = uuid.uuid4().hex[:10],
    created_at: datetime = datetime.utcnow
)

Parameters

Name	Type	Description
name	str	The display name of the collection.
collection_type	[CollectionType](collectiontype.md?sid=app_models_collection_collectiontype) = CollectionType.MANUAL	Whether the collection is manual or smart.
bookmark_ids	List[str] = []	Ordered list of bookmark IDs.
filter_rule	str = ""	Query string for smart collections.
is_pinned	bool = False	Whether the collection is pinned in the sidebar.
id	str = uuid.uuid4().hex[:10]	Unique identifier for the collection.
created_at	datetime = datetime.utcnow	The timestamp when the collection was created.

---

Methods

---

size()

@classmethod
def size() - > int

Number of bookmarks in the collection.

Returns

Type	Description
int	The total count of bookmark IDs currently stored in the collection

---

is_smart()

@classmethod
def is_smart() - > bool

Whether this collection auto-populates based on a filter rule.

Returns

Type	Description
bool	True if the collection type is SMART, False otherwise

---

add_bookmark()

@classmethod
def add_bookmark(
    bookmark_id: str
) - > bool

Add a bookmark to a manual collection.

Parameters

Name	Type	Description
bookmark_id	str	ID of the bookmark to add.

Returns

Type	Description
bool	True if added, False if already present or collection is smart.

---

remove_bookmark()

@classmethod
def remove_bookmark(
    bookmark_id: str
) - > bool

Remove a bookmark from the collection.

Parameters

Name	Type	Description
bookmark_id	str	The unique identifier of the bookmark to be removed

Returns

Type	Description
bool	True if the bookmark was successfully removed, False if the ID was not found in the collection

---

reorder()

@classmethod
def reorder(
    bookmark_ids: List[str]
)

Replace the bookmark ordering.

Parameters

Name	Type	Description
bookmark_ids	List[str]	New ordered list. Must contain the same IDs.

---

pin()

@classmethod
def pin()

Pin the collection to the top of the sidebar.

---

unpin()

@classmethod
def unpin()

Unpin the collection.

---

to_dict()

@classmethod
def to_dict() - > Dict[str, Any]

Serialise to JSON-safe dictionary.

Returns

Type	Description
Dict[str, Any]	A dictionary containing the collection's metadata, bookmark IDs, and state

---

from_dict()

@classmethod
def from_dict(
    data: Dict[str, Any]
) - > [Collection](collection.md?sid=app_models_collection_collection)

Construct from a dictionary.

Parameters

Name	Type	Description
data	Dict[str, Any]	A dictionary containing collection attributes such as name, type, and filter_rule

Returns

Type	Description
[Collection](collection.md?sid=app_models_collection_collection)	A new instance of the Collection class populated with the provided data

---