216 lines
8.9 KiB
Go
216 lines
8.9 KiB
Go
// Copyright 2017 Vector Creations Ltd
|
|
// Copyright 2018 New Vector Ltd
|
|
// Copyright 2019-2020 The Matrix.org Foundation C.I.C.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package api
|
|
|
|
import (
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
)
|
|
|
|
// QueryLatestEventsAndStateRequest is a request to QueryLatestEventsAndState
|
|
type QueryLatestEventsAndStateRequest struct {
|
|
// The room ID to query the latest events for.
|
|
RoomID string `json:"room_id"`
|
|
// The state key tuples to fetch from the room current state.
|
|
// If this list is empty or nil then *ALL* current state events are returned.
|
|
StateToFetch []gomatrixserverlib.StateKeyTuple `json:"state_to_fetch"`
|
|
}
|
|
|
|
// QueryLatestEventsAndStateResponse is a response to QueryLatestEventsAndState
|
|
// This is used when sending events to set the prev_events, auth_events and depth.
|
|
// It is also used to tell whether the event is allowed by the event auth rules.
|
|
type QueryLatestEventsAndStateResponse struct {
|
|
// Does the room exist?
|
|
// If the room doesn't exist this will be false and LatestEvents will be empty.
|
|
RoomExists bool `json:"room_exists"`
|
|
// The room version of the room.
|
|
RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"`
|
|
// The latest events in the room.
|
|
// These are used to set the prev_events when sending an event.
|
|
LatestEvents []gomatrixserverlib.EventReference `json:"latest_events"`
|
|
// The state events requested.
|
|
// This list will be in an arbitrary order.
|
|
// These are used to set the auth_events when sending an event.
|
|
// These are used to check whether the event is allowed.
|
|
StateEvents []gomatrixserverlib.HeaderedEvent `json:"state_events"`
|
|
// The depth of the latest events.
|
|
// This is one greater than the maximum depth of the latest events.
|
|
// This is used to set the depth when sending an event.
|
|
Depth int64 `json:"depth"`
|
|
}
|
|
|
|
// QueryStateAfterEventsRequest is a request to QueryStateAfterEvents
|
|
type QueryStateAfterEventsRequest struct {
|
|
// The room ID to query the state in.
|
|
RoomID string `json:"room_id"`
|
|
// The list of previous events to return the events after.
|
|
PrevEventIDs []string `json:"prev_event_ids"`
|
|
// The state key tuples to fetch from the state
|
|
StateToFetch []gomatrixserverlib.StateKeyTuple `json:"state_to_fetch"`
|
|
}
|
|
|
|
// QueryStateAfterEventsResponse is a response to QueryStateAfterEvents
|
|
type QueryStateAfterEventsResponse struct {
|
|
// Does the room exist on this roomserver?
|
|
// If the room doesn't exist this will be false and StateEvents will be empty.
|
|
RoomExists bool `json:"room_exists"`
|
|
// The room version of the room.
|
|
RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"`
|
|
// Do all the previous events exist on this roomserver?
|
|
// If some of previous events do not exist this will be false and StateEvents will be empty.
|
|
PrevEventsExist bool `json:"prev_events_exist"`
|
|
// The state events requested.
|
|
// This list will be in an arbitrary order.
|
|
StateEvents []gomatrixserverlib.HeaderedEvent `json:"state_events"`
|
|
}
|
|
|
|
// QueryEventsByIDRequest is a request to QueryEventsByID
|
|
type QueryEventsByIDRequest struct {
|
|
// The event IDs to look up.
|
|
EventIDs []string `json:"event_ids"`
|
|
}
|
|
|
|
// QueryEventsByIDResponse is a response to QueryEventsByID
|
|
type QueryEventsByIDResponse struct {
|
|
// A list of events with the requested IDs.
|
|
// If the roomserver does not have a copy of a requested event
|
|
// then it will omit that event from the list.
|
|
// If the roomserver thinks it has a copy of the event, but
|
|
// fails to read it from the database then it will fail
|
|
// the entire request.
|
|
// This list will be in an arbitrary order.
|
|
Events []gomatrixserverlib.HeaderedEvent `json:"events"`
|
|
}
|
|
|
|
// QueryMembershipForUserRequest is a request to QueryMembership
|
|
type QueryMembershipForUserRequest struct {
|
|
// ID of the room to fetch membership from
|
|
RoomID string `json:"room_id"`
|
|
// ID of the user for whom membership is requested
|
|
UserID string `json:"user_id"`
|
|
}
|
|
|
|
// QueryMembershipForUserResponse is a response to QueryMembership
|
|
type QueryMembershipForUserResponse struct {
|
|
// The EventID of the latest "m.room.member" event for the sender,
|
|
// if HasBeenInRoom is true.
|
|
EventID string `json:"event_id"`
|
|
// True if the user has been in room before and has either stayed in it or left it.
|
|
HasBeenInRoom bool `json:"has_been_in_room"`
|
|
// True if the user is in room.
|
|
IsInRoom bool `json:"is_in_room"`
|
|
}
|
|
|
|
// QueryMembershipsForRoomRequest is a request to QueryMembershipsForRoom
|
|
type QueryMembershipsForRoomRequest struct {
|
|
// If true, only returns the membership events of "join" membership
|
|
JoinedOnly bool `json:"joined_only"`
|
|
// ID of the room to fetch memberships from
|
|
RoomID string `json:"room_id"`
|
|
// ID of the user sending the request
|
|
Sender string `json:"sender"`
|
|
}
|
|
|
|
// QueryMembershipsForRoomResponse is a response to QueryMembershipsForRoom
|
|
type QueryMembershipsForRoomResponse struct {
|
|
// The "m.room.member" events (of "join" membership) in the client format
|
|
JoinEvents []gomatrixserverlib.ClientEvent `json:"join_events"`
|
|
// True if the user has been in room before and has either stayed in it or
|
|
// left it.
|
|
HasBeenInRoom bool `json:"has_been_in_room"`
|
|
}
|
|
|
|
// QueryServerAllowedToSeeEventRequest is a request to QueryServerAllowedToSeeEvent
|
|
type QueryServerAllowedToSeeEventRequest struct {
|
|
// The event ID to look up invites in.
|
|
EventID string `json:"event_id"`
|
|
// The server interested in the event
|
|
ServerName gomatrixserverlib.ServerName `json:"server_name"`
|
|
}
|
|
|
|
// QueryServerAllowedToSeeEventResponse is a response to QueryServerAllowedToSeeEvent
|
|
type QueryServerAllowedToSeeEventResponse struct {
|
|
// Wether the server in question is allowed to see the event
|
|
AllowedToSeeEvent bool `json:"can_see_event"`
|
|
}
|
|
|
|
// QueryMissingEventsRequest is a request to QueryMissingEvents
|
|
type QueryMissingEventsRequest struct {
|
|
// Events which are known previous to the gap in the timeline.
|
|
EarliestEvents []string `json:"earliest_events"`
|
|
// Latest known events.
|
|
LatestEvents []string `json:"latest_events"`
|
|
// Limit the number of events this query returns.
|
|
Limit int `json:"limit"`
|
|
// The server interested in the event
|
|
ServerName gomatrixserverlib.ServerName `json:"server_name"`
|
|
}
|
|
|
|
// QueryMissingEventsResponse is a response to QueryMissingEvents
|
|
type QueryMissingEventsResponse struct {
|
|
// Missing events, arbritrary order.
|
|
Events []gomatrixserverlib.HeaderedEvent `json:"events"`
|
|
}
|
|
|
|
// QueryStateAndAuthChainRequest is a request to QueryStateAndAuthChain
|
|
type QueryStateAndAuthChainRequest struct {
|
|
// The room ID to query the state in.
|
|
RoomID string `json:"room_id"`
|
|
// The list of prev events for the event. Used to calculate the state at
|
|
// the event
|
|
PrevEventIDs []string `json:"prev_event_ids"`
|
|
// The list of auth events for the event. Used to calculate the auth chain
|
|
AuthEventIDs []string `json:"auth_event_ids"`
|
|
// Should state resolution be ran on the result events?
|
|
// TODO: check call sites and remove if we always want to do state res
|
|
ResolveState bool `json:"resolve_state"`
|
|
}
|
|
|
|
// QueryStateAndAuthChainResponse is a response to QueryStateAndAuthChain
|
|
type QueryStateAndAuthChainResponse struct {
|
|
// Does the room exist on this roomserver?
|
|
// If the room doesn't exist this will be false and StateEvents will be empty.
|
|
RoomExists bool `json:"room_exists"`
|
|
// The room version of the room.
|
|
RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"`
|
|
// Do all the previous events exist on this roomserver?
|
|
// If some of previous events do not exist this will be false and StateEvents will be empty.
|
|
PrevEventsExist bool `json:"prev_events_exist"`
|
|
// The state and auth chain events that were requested.
|
|
// The lists will be in an arbitrary order.
|
|
StateEvents []gomatrixserverlib.HeaderedEvent `json:"state_events"`
|
|
AuthChainEvents []gomatrixserverlib.HeaderedEvent `json:"auth_chain_events"`
|
|
}
|
|
|
|
// QueryRoomVersionCapabilitiesRequest asks for the default room version
|
|
type QueryRoomVersionCapabilitiesRequest struct{}
|
|
|
|
// QueryRoomVersionCapabilitiesResponse is a response to QueryRoomVersionCapabilitiesRequest
|
|
type QueryRoomVersionCapabilitiesResponse struct {
|
|
DefaultRoomVersion gomatrixserverlib.RoomVersion `json:"default"`
|
|
AvailableRoomVersions map[gomatrixserverlib.RoomVersion]string `json:"available"`
|
|
}
|
|
|
|
// QueryRoomVersionForRoomRequest asks for the room version for a given room.
|
|
type QueryRoomVersionForRoomRequest struct {
|
|
RoomID string `json:"room_id"`
|
|
}
|
|
|
|
// QueryRoomVersionForRoomResponse is a response to QueryRoomVersionForRoomRequest
|
|
type QueryRoomVersionForRoomResponse struct {
|
|
RoomVersion gomatrixserverlib.RoomVersion `json:"room_version"`
|
|
}
|