Document the Synapse version of a new module API method (#12917)

This commit is contained in:
Brendan Abolivier 2022-05-30 18:37:52 +02:00 committed by GitHub
parent af7db19e1e
commit cd9fc058de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 1 deletions

View File

@ -0,0 +1 @@
Add storage and module API methods to get monthly active users (and their corresponding appservices) within an optionally specified time range.

View File

@ -1149,7 +1149,10 @@ class ModuleApi:
) )
async def sleep(self, seconds: float) -> None: 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) await self._clock.sleep(seconds)
@ -1435,6 +1438,8 @@ class ModuleApi:
"""Generates list of monthly active users and their services. """Generates list of monthly active users and their services.
Please see corresponding storage docstring for more details. Please see corresponding storage docstring for more details.
Added in Synapse v1.61.0.
Arguments: Arguments:
start_timestamp: If specified, only include users that were first active start_timestamp: If specified, only include users that were first active
at or after this point at or after this point