package
0.13.8
Repository: https://github.com/matrix-org/dendrite.git
Documentation: pkg.go.dev

# Functions

GetEvent returns the event or nil, even on errors.
GetStateEvent returns the current state event in the room or nil.
IsServerBannedFromRoom returns whether the server is banned from a room by server ACLs.
Create a new room hierarchy walker, starting from the provided root room ID.
Create a new empty room set.
PopulatePublicRooms extracts PublicRoom information for all the provided room IDs.
SendEvents to the roomserver The events are written with KindNew.
SendEventWithState writes an event with the specified kind to the roomserver with the state at the event as KindOutlier before it.
SendInputRoomEvents to the roomserver.

# Constants

DoNotSendToOtherServers tells us not to send the event to other matrix servers.
KindNew event extend the contiguous graph going forwards.
KindOld event extend the graph backwards, or fill gaps in history.
KindOutlier event fall outside the contiguous event graph.
The event is a state event and quite possibly happened in the past.
The event is a timeline event and likely just happened.
OutputTypeNewInboundPeek indicates that the kafka event is an OutputNewInboundPeek.
OutputTypeNewInviteEvent indicates that the event is an OutputNewInviteEvent.
OutputTypeNewPeek indicates that the kafka event is an OutputNewPeek.
OutputTypeNewRoomEvent indicates that the event is an OutputNewRoomEvent.
OutputTypeOldRoomEvent indicates that the event is an OutputOldRoomEvent.
OutputTypePurgeRoom indicates the event is an OutputPurgeRoom.
OutputTypeRedactedEvent indicates that the event is an OutputRedactedEvent This event is emitted when a redaction has been 'validated' (meaning both the redaction and the event to redact are known).
OutputTypeRetireInviteEvent indicates that the event is an OutputRetireInviteEvent.
OutputTypeRetirePeek indicates that the kafka event is an OutputRetirePeek.

# Structs

No description provided by the author
ErrInvalidID is an error returned if the userID is invalid.
ErrNotAllowed is an error returned if the user is not allowed to execute some action (e.g.
ErrRoomUnknownOrNotAllowed is an error return if either the provided room ID does not exist, or points to a room that the requester does not have access to.
GetAliasesForRoomIDRequest is a request to GetAliasesForRoomID.
GetAliasesForRoomIDResponse is a response to GetAliasesForRoomID.
GetRoomIDForAliasRequest is a request to GetRoomIDForAlias.
GetRoomIDForAliasResponse is a response to GetRoomIDForAlias.
InputRoomEvent is a matrix room event to add to the room server database.
InputRoomEventsRequest is a request to InputRoomEvents.
InputRoomEventsResponse is a response to InputRoomEvents.
No description provided by the author
No description provided by the author
No description provided by the author
An OutputEvent is an entry in the roomserver output kafka log.
An OutputNewInboundPeek is written whenever a server starts peeking into a room.
An OutputNewInviteEvent is written whenever an invite becomes active.
An OutputNewPeek is written whenever a user starts peeking into a room using a given device.
An OutputNewRoomEvent is written when the roomserver receives a new event.
An OutputOldRoomEvent is written when the roomserver receives an old event.
No description provided by the author
An OutputRedactedEvent is written whenever a redaction has been /validated/.
An OutputRetireInviteEvent is written whenever an existing invite is no longer active.
An OutputRetirePeek is written whenever a user stops peeking into a room.
PerformBackfillRequest is a request to PerformBackfill.
PerformBackfillResponse is a response to PerformBackfill.
No description provided by the author
PerformForgetRequest is a request to PerformForget.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
QueryEventsByIDRequest is a request to QueryEventsByID.
QueryEventsByIDResponse is a response to QueryEventsByID.
No description provided by the author
No description provided by the author
QueryLatestEventsAndStateRequest is a request to QueryLatestEventsAndState.
QueryLatestEventsAndStateResponse is a response to QueryLatestEventsAndState This is used when sending events to set the prev_events, auth_events and depth.
QueryLeftUsersRequest is a request to calculate users that we (the server) don't share a a room with anymore.
QueryLeftUsersResponse is the response to QueryLeftUsersRequest.
QueryMembershipForUserRequest is a request to QueryMembership.
QueryMembershipForUserResponse is a response to QueryMembership.
QueryMembershipsForRoomRequest is a request to QueryMembershipsForRoom.
QueryMembershipsForRoomResponse is a response to QueryMembershipsForRoom.
QueryMissingEventsRequest is a request to QueryMissingEvents.
QueryMissingEventsResponse is a response to QueryMissingEvents.
No description provided by the author
No description provided by the author
No description provided by the author
QueryRoomVersionForRoomRequest asks for the room version for a given room.
QueryRoomVersionForRoomResponse is a response to QueryRoomVersionForRoomRequest.
QueryServerAllowedToSeeEventRequest is a request to QueryServerAllowedToSeeEvent.
QueryServerAllowedToSeeEventResponse is a response to QueryServerAllowedToSeeEvent.
No description provided by the author
No description provided by the author
QueryServerJoinedToRoomRequest is a request to QueryServerJoinedToRoom.
QueryMembershipsForRoomResponse is a response to QueryServerJoinedToRoom.
No description provided by the author
No description provided by the author
QueryStateAfterEventsRequest is a request to QueryStateAfterEvents.
QueryStateAfterEventsResponse is a response to QueryStateAfterEvents.
QueryStateAndAuthChainRequest is a request to QueryStateAndAuthChain.
QueryStateAndAuthChainResponse is a response to QueryStateAndAuthChain.
A struct storing the intermediate state of a room hierarchy query for pagination purposes.
No description provided by the author
TransactionID contains the transaction ID sent by a client when sending an event, along with the ID of the client session.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
QueryBulkStateContent does a bulk query for state event content in the given rooms.
No description provided by the author
Query the latest events and state for a room from the room server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RoomserverInputAPI is used to write events to the room server.
API functions required by the syncapi.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
Type of the OutputNewRoomEvent.
An OutputType is a type of roomserver output.
A set of room IDs.