Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Document the Synapse version of a new module API method (#12917)
Browse files Browse the repository at this point in the history
  • Loading branch information
babolivier authored May 30, 2022
1 parent af7db19 commit cd9fc05
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelog.d/12917.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add storage and module API methods to get monthly active users (and their corresponding appservices) within an optionally specified time range.
7 changes: 6 additions & 1 deletion synapse/module_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1149,7 +1149,10 @@ def looping_background_call(
)

async def sleep(self, seconds: float) -> None:
"""Sleeps for the given number of seconds."""
"""Sleeps for the given number of seconds.
Added in Synapse v1.49.0.
"""

await self._clock.sleep(seconds)

Expand Down Expand Up @@ -1435,6 +1438,8 @@ async def get_monthly_active_users_by_service(
"""Generates list of monthly active users and their services.
Please see corresponding storage docstring for more details.
Added in Synapse v1.61.0.
Arguments:
start_timestamp: If specified, only include users that were first active
at or after this point
Expand Down

0 comments on commit cd9fc05

Please sign in to comment.