mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-12 09:23:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

More comment

Browse source
This commit is contained in:
Mark Haines 2017-08-07 15:44:56 +01:00
parent 2d2fff1aa4
commit fdcf72836a
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/github.com/matrix-org/dendrite/roomserver/types/types.go
View file

@ -181,6 +181,8 @@ type RoomRecentEventsUpdater interface {
// A MembershipUpdater is used to update the membership of a user in a room. // A MembershipUpdater is used to update the membership of a user in a room.
// (On postgresql this wraps a database transaction that holds a "FOR UPDATE" // (On postgresql this wraps a database transaction that holds a "FOR UPDATE"
// lock on the row in the membership table for this user in the room) // lock on the row in the membership table for this user in the room)
// The caller should call one of SetToInvite, SetToJoin or SetToLeave once to
// make the update, or none of them if no update is required.
type MembershipUpdater interface { type MembershipUpdater interface {
// True if the target user is invited to the room. // True if the target user is invited to the room.
IsInvite() bool IsInvite() bool
@ -192,6 +194,7 @@ type MembershipUpdater interface {
// Returns whether this invite needs to be sent // Returns whether this invite needs to be sent
SetToInvite(event gomatrixserverlib.Event) (needsSending bool, err error) SetToInvite(event gomatrixserverlib.Event) (needsSending bool, err error)
// Set the state to join. // Set the state to join.
// Returns a list of invite event IDs that this state change retired.
SetToJoin(senderUserID string) (inviteEventIDs []string, err error) SetToJoin(senderUserID string) (inviteEventIDs []string, err error)
// Set the state to leave. // Set the state to leave.
// Returns a list of invite event IDs that this state change retired. // Returns a list of invite event IDs that this state change retired.