Skip to content

Commit

Permalink
Clarify when 3PID invite module callbacks are called (#17627)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Eastwood <[email protected]>
  • Loading branch information
anoadragon453 and MadLittleMods authored Oct 14, 2024
1 parent f6a3e5e commit 451a9dc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions changelog.d/17627.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify when the `user_may_invite` and `user_may_send_3pid_invite` module callbacks are called.
9 changes: 6 additions & 3 deletions docs/modules/spam_checker_callbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,9 @@ _Changed in Synapse v1.62.0: `synapse.module_api.NOT_SPAM` and `synapse.module_a
async def user_may_invite(inviter: str, invitee: str, room_id: str) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes", bool]
```

Called when processing an invitation. Both inviter and invitee are
represented by their Matrix user ID (e.g. `@alice:example.com`).
Called when processing an invitation, both when one is created locally or when
receiving an invite over federation. Both inviter and invitee are represented by
their Matrix user ID (e.g. `@alice:example.com`).


The callback must return one of:
Expand Down Expand Up @@ -112,7 +113,9 @@ async def user_may_send_3pid_invite(
```

Called when processing an invitation using a third-party identifier (also called a 3PID,
e.g. an email address or a phone number).
e.g. an email address or a phone number). It is only called when a 3PID invite is created
locally - not when one is received in a room over federation. If the 3PID is already associated
with a Matrix ID, the spam check will go through the `user_may_invite` callback instead.

The inviter is represented by their Matrix user ID (e.g. `@alice:example.com`), and the
invitee is represented by its medium (e.g. "email") and its address
Expand Down

0 comments on commit 451a9dc

Please sign in to comment.