package
0.0.0-20241025030232-2154053700bb
Repository: https://github.com/cipherblock-chat/chat.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.
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.
In order to honour redactions correctly, downstream components must ignore m.room.redaction events emitted via OutputTypeNewRoomEvent.
OutputTypeRetireInviteEvent indicates that the event is an OutputRetireInviteEvent.
OutputTypeRetirePeek indicates that the kafka event is an OutputRetirePeek.
PerformErrorBadRequest means the request was wrong in some way (invalid user ID, wrong server, etc).
PerformErrorNoOperation means that the request resulted in nothing happening e.g invite->invite or leave->leave.
PerformErrorNoRoom means that the room being joined doesn't exist.
PerformErrorNotAllowed means the user is not allowed to invite/join/etc this room (e.g join_rule:invite or banned).
PerformErrRemote means that the request failed and the PerformError.Msg is the raw remote JSON error response.
# Structs
No description provided by the author
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.
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.
When we talk about state in a matrix room we are talking about the state after a list of events.
Old events do not update forward extremities or the current room state, therefore they must not be treated as if they do.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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
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.
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
No description provided by the author
No description provided by the author
No description provided by the author
QueryRoomVersionCapabilitiesRequest asks for the default room version.
QueryRoomVersionCapabilitiesResponse is a response to QueryRoomVersionCapabilitiesRequest.
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.
RemoveRoomAliasRequest is a request to RemoveRoomAlias.
RemoveRoomAliasResponse is a response to RemoveRoomAlias.
RoomserverInternalAPITrace wraps a RoomserverInternalAPI and logs the complete request/response/error.
SetRoomAliasRequest is a request to SetRoomAlias.
SetRoomAliasResponse is a response to SetRoomAlias.
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
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.
RoomserverInputAPI is used to write events to the room server.
API functions required by the syncapi.
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.
No description provided by the author