subscription: Include archived channels in streams list.

`is_archived` field is added to the stream and types.

Include a new `archived_channeels` client capability, to allow clients
to access data on archived channels, without breaking
backwards-compatibility for existing clients that don't know how to
handle these.

Also, included `exclude_archived` parameter to `/get-streams`,
which defaults to `true` as basic clients may not be interested
in archived streams.
This commit is contained in:
sanchi-t
2024-01-18 21:08:48 +05:30
committed by Tim Abbott
parent c6fc25e5df
commit af7ebde9e4
18 changed files with 215 additions and 26 deletions

View File

@@ -144,6 +144,7 @@ class RawStreamDict(TypedDict):
can_remove_subscribers_group_id: int
creator_id: int | None
date_created: datetime
deactivated: bool
description: str
first_message_id: int | None
history_public_to_subscribers: bool
@@ -193,6 +194,7 @@ class SubscriptionStreamDict(TypedDict):
in_home_view: bool
invite_only: bool
is_announcement_only: bool
is_archived: bool
is_muted: bool
is_web_public: bool
message_retention_days: int | None
@@ -208,6 +210,7 @@ class SubscriptionStreamDict(TypedDict):
class NeverSubscribedStreamDict(TypedDict):
is_archived: bool
can_remove_subscribers_group: int
creator_id: int | None
date_created: int
@@ -232,6 +235,7 @@ class DefaultStreamDict(TypedDict):
with few exceptions and possible additional fields.
"""
is_archived: bool
can_remove_subscribers_group: int
creator_id: int | None
date_created: int