Explain when we should use SendEvents instead of SendInvite.

Because it's easy to get confused between the two methods.
This commit is contained in:
Mark Haines 2017-09-12 16:54:37 +01:00
parent f1fce55697
commit 82c82a3412

View File

@ -86,6 +86,8 @@ func (c *RoomserverProducer) SendInputRoomEvents(ires []api.InputRoomEvent) erro
}
// SendInvite writes the invite event to the roomserver input API.
// This should only be needed for invite events that occur outside of a known room.
// If we are in the room then the event should be sent using the SendEvents method.
func (c *RoomserverProducer) SendInvite(inviteEvent gomatrixserverlib.Event) error {
request := api.InputRoomEventsRequest{
InputInviteEvents: []api.InputInviteEvent{{Event: inviteEvent}},