mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-09-08 06:52:12 +00:00
Move the doc string to the public facing method
This commit is contained in:
parent
9ac417fa88
commit
517fb9a023
@ -330,6 +330,23 @@ class MessageHandler(BaseHandler):
|
|||||||
|
|
||||||
def snapshot_all_rooms(self, user_id=None, pagin_config=None,
|
def snapshot_all_rooms(self, user_id=None, pagin_config=None,
|
||||||
as_client_event=True, include_archived=False):
|
as_client_event=True, include_archived=False):
|
||||||
|
"""Retrieve a snapshot of all rooms the user is invited or has joined.
|
||||||
|
|
||||||
|
This snapshot may include messages for all rooms where the user is
|
||||||
|
joined, depending on the pagination config.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id (str): The ID of the user making the request.
|
||||||
|
pagin_config (synapse.api.streams.PaginationConfig): The pagination
|
||||||
|
config used to determine how many messages *PER ROOM* to return.
|
||||||
|
as_client_event (bool): True to get events in client-server format.
|
||||||
|
include_archived (bool): True to get rooms that the user has left
|
||||||
|
Returns:
|
||||||
|
A list of dicts with "room_id" and "membership" keys for all rooms
|
||||||
|
the user is currently invited or joined in on. Rooms where the user
|
||||||
|
is joined on, may return a "messages" key with messages, depending
|
||||||
|
on the specified PaginationConfig.
|
||||||
|
"""
|
||||||
key = (
|
key = (
|
||||||
user_id,
|
user_id,
|
||||||
pagin_config.from_token,
|
pagin_config.from_token,
|
||||||
@ -351,23 +368,7 @@ class MessageHandler(BaseHandler):
|
|||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def _snapshot_all_rooms(self, user_id=None, pagin_config=None,
|
def _snapshot_all_rooms(self, user_id=None, pagin_config=None,
|
||||||
as_client_event=True, include_archived=False):
|
as_client_event=True, include_archived=False):
|
||||||
"""Retrieve a snapshot of all rooms the user is invited or has joined.
|
|
||||||
|
|
||||||
This snapshot may include messages for all rooms where the user is
|
|
||||||
joined, depending on the pagination config.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
user_id (str): The ID of the user making the request.
|
|
||||||
pagin_config (synapse.api.streams.PaginationConfig): The pagination
|
|
||||||
config used to determine how many messages *PER ROOM* to return.
|
|
||||||
as_client_event (bool): True to get events in client-server format.
|
|
||||||
include_archived (bool): True to get rooms that the user has left
|
|
||||||
Returns:
|
|
||||||
A list of dicts with "room_id" and "membership" keys for all rooms
|
|
||||||
the user is currently invited or joined in on. Rooms where the user
|
|
||||||
is joined on, may return a "messages" key with messages, depending
|
|
||||||
on the specified PaginationConfig.
|
|
||||||
"""
|
|
||||||
memberships = [Membership.INVITE, Membership.JOIN]
|
memberships = [Membership.INVITE, Membership.JOIN]
|
||||||
if include_archived:
|
if include_archived:
|
||||||
memberships.append(Membership.LEAVE)
|
memberships.append(Membership.LEAVE)
|
||||||
|
Loading…
Reference in New Issue
Block a user