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

Commit 2b1fe9a

Browse files
committed
update function docstring description to new updated enum values.
1 parent ed6b772 commit 2b1fe9a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

synapse/storage/databases/main/events_worker.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -362,9 +362,9 @@ async def get_event(
362362
event_id: The event_id of the event to fetch
363363
364364
redact_behaviour: Determine what to do with a redacted event. Possible values:
365-
* AS_IS - Return the full event body with no redacted content
366-
* REDACT - Return the event but with a redacted body
367-
* DISALLOW - Do not return redacted events (behave as per allow_none
365+
* as_is - Return the full event body with no redacted content
366+
* redact - Return the event but with a redacted body
367+
* block - Do not return redacted events (behave as per allow_none
368368
if the event is redacted)
369369
370370
get_prev_content: If True and event is a state event,
@@ -417,9 +417,9 @@ async def get_events(
417417
418418
redact_behaviour: Determine what to do with a redacted event. Possible
419419
values:
420-
* AS_IS - Return the full event body with no redacted content
421-
* REDACT - Return the event but with a redacted body
422-
* DISALLOW - Do not return redacted events (omit them from the response)
420+
* as_is - Return the full event body with no redacted content
421+
* redact - Return the event but with a redacted body
422+
* block - Do not return redacted events (omit them from the response)
423423
424424
get_prev_content: If True and event is a state event,
425425
include the previous states content in the unsigned field.
@@ -455,9 +455,9 @@ async def get_events_as_list(
455455
event_ids: The event_ids of the events to fetch
456456
457457
redact_behaviour: Determine what to do with a redacted event. Possible values:
458-
* AS_IS - Return the full event body with no redacted content
459-
* REDACT - Return the event but with a redacted body
460-
* DISALLOW - Do not return redacted events (omit them from the response)
458+
* as_is - Return the full event body with no redacted content
459+
* redact - Return the event but with a redacted body
460+
* block - Do not return redacted events (omit them from the response)
461461
462462
get_prev_content: If True and event is a state event,
463463
include the previous states content in the unsigned field.

0 commit comments

Comments
 (0)