room303connect

package
v1.9.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Room303APIAddRoomMemberProcedure is the fully-qualified name of the Room303API's AddRoomMember
	// RPC.
	Room303APIAddRoomMemberProcedure = "/api.v1alpha1.room303.Room303API/AddRoomMember"
	// Room303APIRemoveRoomMemberProcedure is the fully-qualified name of the Room303API's
	// RemoveRoomMember RPC.
	Room303APIRemoveRoomMemberProcedure = "/api.v1alpha1.room303.Room303API/RemoveRoomMember"
	// Room303APIListRoomMembersProcedure is the fully-qualified name of the Room303API's
	// ListRoomMembers RPC.
	Room303APIListRoomMembersProcedure = "/api.v1alpha1.room303.Room303API/ListRoomMembers"
	// Room303APISetAdminForRoomMemberProcedure is the fully-qualified name of the Room303API's
	// SetAdminForRoomMember RPC.
	Room303APISetAdminForRoomMemberProcedure = "/api.v1alpha1.room303.Room303API/SetAdminForRoomMember"
	// Room303APIJoinRoomProcedure is the fully-qualified name of the Room303API's JoinRoom RPC.
	Room303APIJoinRoomProcedure = "/api.v1alpha1.room303.Room303API/JoinRoom"
	// Room303APIGetRoomMemberProcedure is the fully-qualified name of the Room303API's GetRoomMember
	// RPC.
	Room303APIGetRoomMemberProcedure = "/api.v1alpha1.room303.Room303API/GetRoomMember"
	// Room303APICreateMessageProcedure is the fully-qualified name of the Room303API's CreateMessage
	// RPC.
	Room303APICreateMessageProcedure = "/api.v1alpha1.room303.Room303API/CreateMessage"
	// Room303APIEditMessageProcedure is the fully-qualified name of the Room303API's EditMessage RPC.
	Room303APIEditMessageProcedure = "/api.v1alpha1.room303.Room303API/EditMessage"
	// Room303APIDeleteMessageProcedure is the fully-qualified name of the Room303API's DeleteMessage
	// RPC.
	Room303APIDeleteMessageProcedure = "/api.v1alpha1.room303.Room303API/DeleteMessage"
	// Room303APIGetMessagesProcedure is the fully-qualified name of the Room303API's GetMessages RPC.
	Room303APIGetMessagesProcedure = "/api.v1alpha1.room303.Room303API/GetMessages"
	// Room303APIStreamMessageUpdatesProcedure is the fully-qualified name of the Room303API's
	// StreamMessageUpdates RPC.
	Room303APIStreamMessageUpdatesProcedure = "/api.v1alpha1.room303.Room303API/StreamMessageUpdates"
	// Room303APIGetUnreadStatsProcedure is the fully-qualified name of the Room303API's GetUnreadStats
	// RPC.
	Room303APIGetUnreadStatsProcedure = "/api.v1alpha1.room303.Room303API/GetUnreadStats"
	// Room303APIMarkMessageReadProcedure is the fully-qualified name of the Room303API's
	// MarkMessageRead RPC.
	Room303APIMarkMessageReadProcedure = "/api.v1alpha1.room303.Room303API/MarkMessageRead"
	// Room303APIMarkAllMessagesReadProcedure is the fully-qualified name of the Room303API's
	// MarkAllMessagesRead RPC.
	Room303APIMarkAllMessagesReadProcedure = "/api.v1alpha1.room303.Room303API/MarkAllMessagesRead"
	// Room303APIBulkMarkMessageReadProcedure is the fully-qualified name of the Room303API's
	// BulkMarkMessageRead RPC.
	Room303APIBulkMarkMessageReadProcedure = "/api.v1alpha1.room303.Room303API/BulkMarkMessageRead"
	// Room303APICreateRoomProcedure is the fully-qualified name of the Room303API's CreateRoom RPC.
	Room303APICreateRoomProcedure = "/api.v1alpha1.room303.Room303API/CreateRoom"
	// Room303APIGetRoomProcedure is the fully-qualified name of the Room303API's GetRoom RPC.
	Room303APIGetRoomProcedure = "/api.v1alpha1.room303.Room303API/GetRoom"
	// Room303APIListAllRoomsProcedure is the fully-qualified name of the Room303API's ListAllRooms RPC.
	Room303APIListAllRoomsProcedure = "/api.v1alpha1.room303.Room303API/ListAllRooms"
	// Room303APIListRoomsForMemberProcedure is the fully-qualified name of the Room303API's
	// ListRoomsForMember RPC.
	Room303APIListRoomsForMemberProcedure = "/api.v1alpha1.room303.Room303API/ListRoomsForMember"
	// Room303APIArchiveRoomProcedure is the fully-qualified name of the Room303API's ArchiveRoom RPC.
	Room303APIArchiveRoomProcedure = "/api.v1alpha1.room303.Room303API/ArchiveRoom"
	// Room303APIListUsersNamesProcedure is the fully-qualified name of the Room303API's ListUsersNames
	// RPC.
	Room303APIListUsersNamesProcedure = "/api.v1alpha1.room303.Room303API/ListUsersNames"
	// Room303APIUpdateRoomConfigProcedure is the fully-qualified name of the Room303API's
	// UpdateRoomConfig RPC.
	Room303APIUpdateRoomConfigProcedure = "/api.v1alpha1.room303.Room303API/UpdateRoomConfig"
	// Room303APIUpdateGlobalConfigProcedure is the fully-qualified name of the Room303API's
	// UpdateGlobalConfig RPC.
	Room303APIUpdateGlobalConfigProcedure = "/api.v1alpha1.room303.Room303API/UpdateGlobalConfig"
	// Room303APIGetGlobalConfigProcedure is the fully-qualified name of the Room303API's
	// GetGlobalConfig RPC.
	Room303APIGetGlobalConfigProcedure = "/api.v1alpha1.room303.Room303API/GetGlobalConfig"
	// Room303APIUpdateRoomProcedure is the fully-qualified name of the Room303API's UpdateRoom RPC.
	Room303APIUpdateRoomProcedure = "/api.v1alpha1.room303.Room303API/UpdateRoom"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// Room303APIName is the fully-qualified name of the Room303API service.
	Room303APIName = "api.v1alpha1.room303.Room303API"
)

Variables

This section is empty.

Functions

func NewRoom303APIHandler

func NewRoom303APIHandler(svc Room303APIHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewRoom303APIHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type Room303APIClient

type Room303APIClient interface {
	// Member
	//
	// Add a new member to a room, you must be a room admin in order to do that
	AddRoomMember(context.Context, *connect_go.Request[room303.AddRoomMemberRequest]) (*connect_go.Response[commons.Member], error)
	// Remove room member (kick), the room member will not receive notifications from that room
	RemoveRoomMember(context.Context, *connect_go.Request[room303.RemoveRoomMemberRequest]) (*connect_go.Response[room303.RemoveRoomMemberResponse], error)
	// List the members of this room
	ListRoomMembers(context.Context, *connect_go.Request[room303.ListRoomMembersRequest]) (*connect_go.Response[room303.ListRoomMembersResponse], error)
	// Set a room member as admin, you must be a room admin in order to do this.
	SetAdminForRoomMember(context.Context, *connect_go.Request[room303.SetAdminForRoomMemberRequest]) (*connect_go.Response[room303.SetAdminForRoomMemberResponse], error)
	// adds new member to a room and does not require the member to be admin
	JoinRoom(context.Context, *connect_go.Request[room303.JoinRoomRequest]) (*connect_go.Response[commons.Room], error)
	// gets the member entity from the provided room if it exists
	GetRoomMember(context.Context, *connect_go.Request[room303.GetRoomMemberRequest]) (*connect_go.Response[commons.Member], error)
	// Message
	CreateMessage(context.Context, *connect_go.Request[room303.CreateMessageRequest]) (*connect_go.Response[room303.CreateMessageResponse], error)
	EditMessage(context.Context, *connect_go.Request[room303.EditMessageRequest]) (*connect_go.Response[room303.EditMessageResponse], error)
	DeleteMessage(context.Context, *connect_go.Request[room303.DeleteMessageRequest]) (*connect_go.Response[room303.DeleteMessageResponse], error)
	GetMessages(context.Context, *connect_go.Request[room303.GetMessagesRequest]) (*connect_go.Response[room303.GetMessagesResponse], error)
	StreamMessageUpdates(context.Context, *connect_go.Request[room303.StreamMessageUpdatesRequest]) (*connect_go.ServerStreamForClient[room303.StreamMessageUpdatesResponse], error)
	GetUnreadStats(context.Context, *connect_go.Request[room303.GetUnreadStatsRequest]) (*connect_go.Response[room303.GetUnreadStatsResponse], error)
	MarkMessageRead(context.Context, *connect_go.Request[room303.MarkMessageReadRequest]) (*connect_go.Response[room303.MarkMessageReadResponse], error)
	MarkAllMessagesRead(context.Context, *connect_go.Request[room303.MarkAllMessagesReadRequest]) (*connect_go.Response[room303.MarkAllMessagesReadResponse], error)
	BulkMarkMessageRead(context.Context, *connect_go.Request[room303.BulkMarkMessageReadRequest]) (*connect_go.Response[room303.BulkMarkMessageReadResponse], error)
	// Room
	CreateRoom(context.Context, *connect_go.Request[room303.CreateRoomRequest]) (*connect_go.Response[commons.Room], error)
	GetRoom(context.Context, *connect_go.Request[room303.GetRoomRequest]) (*connect_go.Response[commons.Room], error)
	ListAllRooms(context.Context, *connect_go.Request[room303.ListAllRoomsRequest]) (*connect_go.Response[room303.ListRoomsResponse], error)
	ListRoomsForMember(context.Context, *connect_go.Request[room303.ListRoomsForMemberRequest]) (*connect_go.Response[room303.ListRoomsResponse], error)
	ArchiveRoom(context.Context, *connect_go.Request[room303.ArchiveRoomRequest]) (*connect_go.Response[commons.Room], error)
	// ListUsersNames returns a list of users with names and ids
	ListUsersNames(context.Context, *connect_go.Request[room303.ListUsersNamesRequest]) (*connect_go.ServerStreamForClient[room303.ListUsersNamesResponse], error)
	// allow room configurations to be updated
	UpdateRoomConfig(context.Context, *connect_go.Request[room303.UpdateRoomConfigRequest]) (*connect_go.Response[commons.Room], error)
	// update global configuration
	UpdateGlobalConfig(context.Context, *connect_go.Request[room303.UpdateGlobalConfigRequest]) (*connect_go.Response[room303.UpdateGlobalConfigResponse], error)
	// get global configuration
	GetGlobalConfig(context.Context, *connect_go.Request[room303.GetGlobalConfigRequest]) (*connect_go.Response[room303.GetGlobalConfigResponse], error)
	// allow room to be updated
	UpdateRoom(context.Context, *connect_go.Request[room303.UpdateRoomRequest]) (*connect_go.Response[commons.Room], error)
}

Room303APIClient is a client for the api.v1alpha1.room303.Room303API service.

func NewRoom303APIClient

func NewRoom303APIClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) Room303APIClient

NewRoom303APIClient constructs a client for the api.v1alpha1.room303.Room303API service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type Room303APIHandler

type Room303APIHandler interface {
	// Member
	//
	// Add a new member to a room, you must be a room admin in order to do that
	AddRoomMember(context.Context, *connect_go.Request[room303.AddRoomMemberRequest]) (*connect_go.Response[commons.Member], error)
	// Remove room member (kick), the room member will not receive notifications from that room
	RemoveRoomMember(context.Context, *connect_go.Request[room303.RemoveRoomMemberRequest]) (*connect_go.Response[room303.RemoveRoomMemberResponse], error)
	// List the members of this room
	ListRoomMembers(context.Context, *connect_go.Request[room303.ListRoomMembersRequest]) (*connect_go.Response[room303.ListRoomMembersResponse], error)
	// Set a room member as admin, you must be a room admin in order to do this.
	SetAdminForRoomMember(context.Context, *connect_go.Request[room303.SetAdminForRoomMemberRequest]) (*connect_go.Response[room303.SetAdminForRoomMemberResponse], error)
	// adds new member to a room and does not require the member to be admin
	JoinRoom(context.Context, *connect_go.Request[room303.JoinRoomRequest]) (*connect_go.Response[commons.Room], error)
	// gets the member entity from the provided room if it exists
	GetRoomMember(context.Context, *connect_go.Request[room303.GetRoomMemberRequest]) (*connect_go.Response[commons.Member], error)
	// Message
	CreateMessage(context.Context, *connect_go.Request[room303.CreateMessageRequest]) (*connect_go.Response[room303.CreateMessageResponse], error)
	EditMessage(context.Context, *connect_go.Request[room303.EditMessageRequest]) (*connect_go.Response[room303.EditMessageResponse], error)
	DeleteMessage(context.Context, *connect_go.Request[room303.DeleteMessageRequest]) (*connect_go.Response[room303.DeleteMessageResponse], error)
	GetMessages(context.Context, *connect_go.Request[room303.GetMessagesRequest]) (*connect_go.Response[room303.GetMessagesResponse], error)
	StreamMessageUpdates(context.Context, *connect_go.Request[room303.StreamMessageUpdatesRequest], *connect_go.ServerStream[room303.StreamMessageUpdatesResponse]) error
	GetUnreadStats(context.Context, *connect_go.Request[room303.GetUnreadStatsRequest]) (*connect_go.Response[room303.GetUnreadStatsResponse], error)
	MarkMessageRead(context.Context, *connect_go.Request[room303.MarkMessageReadRequest]) (*connect_go.Response[room303.MarkMessageReadResponse], error)
	MarkAllMessagesRead(context.Context, *connect_go.Request[room303.MarkAllMessagesReadRequest]) (*connect_go.Response[room303.MarkAllMessagesReadResponse], error)
	BulkMarkMessageRead(context.Context, *connect_go.Request[room303.BulkMarkMessageReadRequest]) (*connect_go.Response[room303.BulkMarkMessageReadResponse], error)
	// Room
	CreateRoom(context.Context, *connect_go.Request[room303.CreateRoomRequest]) (*connect_go.Response[commons.Room], error)
	GetRoom(context.Context, *connect_go.Request[room303.GetRoomRequest]) (*connect_go.Response[commons.Room], error)
	ListAllRooms(context.Context, *connect_go.Request[room303.ListAllRoomsRequest]) (*connect_go.Response[room303.ListRoomsResponse], error)
	ListRoomsForMember(context.Context, *connect_go.Request[room303.ListRoomsForMemberRequest]) (*connect_go.Response[room303.ListRoomsResponse], error)
	ArchiveRoom(context.Context, *connect_go.Request[room303.ArchiveRoomRequest]) (*connect_go.Response[commons.Room], error)
	// ListUsersNames returns a list of users with names and ids
	ListUsersNames(context.Context, *connect_go.Request[room303.ListUsersNamesRequest], *connect_go.ServerStream[room303.ListUsersNamesResponse]) error
	// allow room configurations to be updated
	UpdateRoomConfig(context.Context, *connect_go.Request[room303.UpdateRoomConfigRequest]) (*connect_go.Response[commons.Room], error)
	// update global configuration
	UpdateGlobalConfig(context.Context, *connect_go.Request[room303.UpdateGlobalConfigRequest]) (*connect_go.Response[room303.UpdateGlobalConfigResponse], error)
	// get global configuration
	GetGlobalConfig(context.Context, *connect_go.Request[room303.GetGlobalConfigRequest]) (*connect_go.Response[room303.GetGlobalConfigResponse], error)
	// allow room to be updated
	UpdateRoom(context.Context, *connect_go.Request[room303.UpdateRoomRequest]) (*connect_go.Response[commons.Room], error)
}

Room303APIHandler is an implementation of the api.v1alpha1.room303.Room303API service.

type UnimplementedRoom303APIHandler

type UnimplementedRoom303APIHandler struct{}

UnimplementedRoom303APIHandler returns CodeUnimplemented from all methods.

func (UnimplementedRoom303APIHandler) UpdateRoom added in v1.7.70

func (UnimplementedRoom303APIHandler) UpdateRoomConfig added in v1.7.43

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL