Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
- type ServiceClient
- type ServiceServer
- type Service_UploadProfileImageClient
- type Service_UploadProfileImageServer
- type UnimplementedServiceServer
- func (UnimplementedServiceServer) AcceptContact(context.Context, *user.AcceptContactRequest) (*user.AcceptContactResponse, error)
- func (UnimplementedServiceServer) AddContact(context.Context, *user.AddContactRequest) (*user.AddContactResponse, error)
- func (UnimplementedServiceServer) Create(context.Context, *user.CreateRequest) (*user.CreateResponse, error)
- func (UnimplementedServiceServer) Delete(context.Context, *user.DeleteRequest) (*user.DeleteResponse, error)
- func (UnimplementedServiceServer) DeleteMany(context.Context, *user.DeleteManyRequest) (*user.DeleteManyResponse, error)
- func (UnimplementedServiceServer) Get(context.Context, *user.GetRequest) (*user.GetResponse, error)
- func (UnimplementedServiceServer) GetContacts(context.Context, *user.GetContactsRequest) (*user.GetContactsResponse, error)
- func (UnimplementedServiceServer) GetMany(context.Context, *user.GetManyRequest) (*user.GetManyResponse, error)
- func (UnimplementedServiceServer) GetSettings(context.Context, *user.GetSettingsRequest) (*user.GetSettingsResponse, error)
- func (UnimplementedServiceServer) List(context.Context, *user.ListRequest) (*user.ListResponse, error)
- func (UnimplementedServiceServer) ListSessions(context.Context, *user.ListSessionsRequest) (*user.ListSessionsResponse, error)
- func (UnimplementedServiceServer) Ping(context.Context, *user.PingRequest) (*user.PingResponse, error)
- func (UnimplementedServiceServer) RemoveContact(context.Context, *user.RemoveContactRequest) (*user.RemoveContactResponse, error)
- func (UnimplementedServiceServer) Search(context.Context, *user.SearchRequest) (*user.SearchResponse, error)
- func (UnimplementedServiceServer) Update(context.Context, *user.UpdateRequest) (*user.UpdateResponse, error)
- func (UnimplementedServiceServer) UpdateSettings(context.Context, *user.UpdateSettingsRequest) (*user.UpdateSettingsResponse, error)
- func (UnimplementedServiceServer) UploadProfileImage(...) error
- type UnsafeServiceServer
Constants ¶
const ( Service_Ping_FullMethodName = "/nuntio.management.api.user.Service/Ping" Service_Create_FullMethodName = "/nuntio.management.api.user.Service/Create" Service_Update_FullMethodName = "/nuntio.management.api.user.Service/Update" Service_UploadProfileImage_FullMethodName = "/nuntio.management.api.user.Service/UploadProfileImage" Service_ListSessions_FullMethodName = "/nuntio.management.api.user.Service/ListSessions" Service_Search_FullMethodName = "/nuntio.management.api.user.Service/Search" Service_Get_FullMethodName = "/nuntio.management.api.user.Service/Get" Service_GetMany_FullMethodName = "/nuntio.management.api.user.Service/GetMany" Service_List_FullMethodName = "/nuntio.management.api.user.Service/List" Service_Delete_FullMethodName = "/nuntio.management.api.user.Service/Delete" Service_DeleteMany_FullMethodName = "/nuntio.management.api.user.Service/DeleteMany" Service_AddContact_FullMethodName = "/nuntio.management.api.user.Service/AddContact" Service_RemoveContact_FullMethodName = "/nuntio.management.api.user.Service/RemoveContact" Service_AcceptContact_FullMethodName = "/nuntio.management.api.user.Service/AcceptContact" Service_GetContacts_FullMethodName = "/nuntio.management.api.user.Service/GetContacts" Service_GetSettings_FullMethodName = "/nuntio.management.api.user.Service/GetSettings" Service_UpdateSettings_FullMethodName = "/nuntio.management.api.user.Service/UpdateSettings" )
Variables ¶
var Service_ServiceDesc = grpc.ServiceDesc{ ServiceName: "nuntio.management.api.user.Service", HandlerType: (*ServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Ping", Handler: _Service_Ping_Handler, }, { MethodName: "Create", Handler: _Service_Create_Handler, }, { MethodName: "Update", Handler: _Service_Update_Handler, }, { MethodName: "ListSessions", Handler: _Service_ListSessions_Handler, }, { MethodName: "Search", Handler: _Service_Search_Handler, }, { MethodName: "Get", Handler: _Service_Get_Handler, }, { MethodName: "GetMany", Handler: _Service_GetMany_Handler, }, { MethodName: "List", Handler: _Service_List_Handler, }, { MethodName: "Delete", Handler: _Service_Delete_Handler, }, { MethodName: "DeleteMany", Handler: _Service_DeleteMany_Handler, }, { MethodName: "AddContact", Handler: _Service_AddContact_Handler, }, { MethodName: "RemoveContact", Handler: _Service_RemoveContact_Handler, }, { MethodName: "AcceptContact", Handler: _Service_AcceptContact_Handler, }, { MethodName: "GetContacts", Handler: _Service_GetContacts_Handler, }, { MethodName: "GetSettings", Handler: _Service_GetSettings_Handler, }, { MethodName: "UpdateSettings", Handler: _Service_UpdateSettings_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "UploadProfileImage", Handler: _Service_UploadProfileImage_Handler, ClientStreams: true, }, }, Metadata: "nuntio/management/api/user/service.proto", }
Service_ServiceDesc is the grpc.ServiceDesc for Service service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterServiceServer ¶
func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
Types ¶
type ServiceClient ¶
type ServiceClient interface {
// Ping a server to check if it is live
Ping(ctx context.Context, in *user.PingRequest, opts ...grpc.CallOption) (*user.PingResponse, error)
// Create a new user
Create(ctx context.Context, in *user.CreateRequest, opts ...grpc.CallOption) (*user.CreateResponse, error)
// Update a users profile and/or contact info
Update(ctx context.Context, in *user.UpdateRequest, opts ...grpc.CallOption) (*user.UpdateResponse, error)
// Uploads a new profile image with a client side stream
UploadProfileImage(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[user.UploadProfileImageRequest, user.UploadProfileImageResponse], error)
// Fetches a users token info
ListSessions(ctx context.Context, in *user.ListSessionsRequest, opts ...grpc.CallOption) (*user.ListSessionsResponse, error)
// Searches for one or more users
Search(ctx context.Context, in *user.SearchRequest, opts ...grpc.CallOption) (*user.SearchResponse, error)
// Get a specific user
Get(ctx context.Context, in *user.GetRequest, opts ...grpc.CallOption) (*user.GetResponse, error)
// Get multiple specific users
GetMany(ctx context.Context, in *user.GetManyRequest, opts ...grpc.CallOption) (*user.GetManyResponse, error)
// List users
List(ctx context.Context, in *user.ListRequest, opts ...grpc.CallOption) (*user.ListResponse, error)
// Delete a specific user
Delete(ctx context.Context, in *user.DeleteRequest, opts ...grpc.CallOption) (*user.DeleteResponse, error)
// Delete many specific users
DeleteMany(ctx context.Context, in *user.DeleteManyRequest, opts ...grpc.CallOption) (*user.DeleteManyResponse, error)
// Add a contact to a user
AddContact(ctx context.Context, in *user.AddContactRequest, opts ...grpc.CallOption) (*user.AddContactResponse, error)
// Remove a contact form a user
RemoveContact(ctx context.Context, in *user.RemoveContactRequest, opts ...grpc.CallOption) (*user.RemoveContactResponse, error)
// Accept a contact request from a user
AcceptContact(ctx context.Context, in *user.AcceptContactRequest, opts ...grpc.CallOption) (*user.AcceptContactResponse, error)
// Get a users contacts
GetContacts(ctx context.Context, in *user.GetContactsRequest, opts ...grpc.CallOption) (*user.GetContactsResponse, error)
// Gets the users settings for the current project.
GetSettings(ctx context.Context, in *user.GetSettingsRequest, opts ...grpc.CallOption) (*user.GetSettingsResponse, error)
// Sets the users settings for the current project.
UpdateSettings(ctx context.Context, in *user.UpdateSettingsRequest, opts ...grpc.CallOption) (*user.UpdateSettingsResponse, error)
}
ServiceClient is the client API for Service service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
The service to manage users in Users
func NewServiceClient ¶
func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient
type ServiceServer ¶
type ServiceServer interface {
// Ping a server to check if it is live
Ping(context.Context, *user.PingRequest) (*user.PingResponse, error)
// Create a new user
Create(context.Context, *user.CreateRequest) (*user.CreateResponse, error)
// Update a users profile and/or contact info
Update(context.Context, *user.UpdateRequest) (*user.UpdateResponse, error)
// Uploads a new profile image with a client side stream
UploadProfileImage(grpc.ClientStreamingServer[user.UploadProfileImageRequest, user.UploadProfileImageResponse]) error
// Fetches a users token info
ListSessions(context.Context, *user.ListSessionsRequest) (*user.ListSessionsResponse, error)
// Searches for one or more users
Search(context.Context, *user.SearchRequest) (*user.SearchResponse, error)
// Get a specific user
Get(context.Context, *user.GetRequest) (*user.GetResponse, error)
// Get multiple specific users
GetMany(context.Context, *user.GetManyRequest) (*user.GetManyResponse, error)
// List users
List(context.Context, *user.ListRequest) (*user.ListResponse, error)
// Delete a specific user
Delete(context.Context, *user.DeleteRequest) (*user.DeleteResponse, error)
// Delete many specific users
DeleteMany(context.Context, *user.DeleteManyRequest) (*user.DeleteManyResponse, error)
// Add a contact to a user
AddContact(context.Context, *user.AddContactRequest) (*user.AddContactResponse, error)
// Remove a contact form a user
RemoveContact(context.Context, *user.RemoveContactRequest) (*user.RemoveContactResponse, error)
// Accept a contact request from a user
AcceptContact(context.Context, *user.AcceptContactRequest) (*user.AcceptContactResponse, error)
// Get a users contacts
GetContacts(context.Context, *user.GetContactsRequest) (*user.GetContactsResponse, error)
// Gets the users settings for the current project.
GetSettings(context.Context, *user.GetSettingsRequest) (*user.GetSettingsResponse, error)
// Sets the users settings for the current project.
UpdateSettings(context.Context, *user.UpdateSettingsRequest) (*user.UpdateSettingsResponse, error)
}
ServiceServer is the server API for Service service. All implementations should embed UnimplementedServiceServer for forward compatibility.
The service to manage users in Users
type Service_UploadProfileImageClient ¶
type Service_UploadProfileImageClient = grpc.ClientStreamingClient[user.UploadProfileImageRequest, user.UploadProfileImageResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type Service_UploadProfileImageServer ¶
type Service_UploadProfileImageServer = grpc.ClientStreamingServer[user.UploadProfileImageRequest, user.UploadProfileImageResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type UnimplementedServiceServer ¶
type UnimplementedServiceServer struct{}
UnimplementedServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedServiceServer) AcceptContact ¶
func (UnimplementedServiceServer) AcceptContact(context.Context, *user.AcceptContactRequest) (*user.AcceptContactResponse, error)
func (UnimplementedServiceServer) AddContact ¶
func (UnimplementedServiceServer) AddContact(context.Context, *user.AddContactRequest) (*user.AddContactResponse, error)
func (UnimplementedServiceServer) Create ¶
func (UnimplementedServiceServer) Create(context.Context, *user.CreateRequest) (*user.CreateResponse, error)
func (UnimplementedServiceServer) Delete ¶
func (UnimplementedServiceServer) Delete(context.Context, *user.DeleteRequest) (*user.DeleteResponse, error)
func (UnimplementedServiceServer) DeleteMany ¶
func (UnimplementedServiceServer) DeleteMany(context.Context, *user.DeleteManyRequest) (*user.DeleteManyResponse, error)
func (UnimplementedServiceServer) Get ¶
func (UnimplementedServiceServer) Get(context.Context, *user.GetRequest) (*user.GetResponse, error)
func (UnimplementedServiceServer) GetContacts ¶
func (UnimplementedServiceServer) GetContacts(context.Context, *user.GetContactsRequest) (*user.GetContactsResponse, error)
func (UnimplementedServiceServer) GetMany ¶
func (UnimplementedServiceServer) GetMany(context.Context, *user.GetManyRequest) (*user.GetManyResponse, error)
func (UnimplementedServiceServer) GetSettings ¶
func (UnimplementedServiceServer) GetSettings(context.Context, *user.GetSettingsRequest) (*user.GetSettingsResponse, error)
func (UnimplementedServiceServer) List ¶
func (UnimplementedServiceServer) List(context.Context, *user.ListRequest) (*user.ListResponse, error)
func (UnimplementedServiceServer) ListSessions ¶
func (UnimplementedServiceServer) ListSessions(context.Context, *user.ListSessionsRequest) (*user.ListSessionsResponse, error)
func (UnimplementedServiceServer) Ping ¶
func (UnimplementedServiceServer) Ping(context.Context, *user.PingRequest) (*user.PingResponse, error)
func (UnimplementedServiceServer) RemoveContact ¶
func (UnimplementedServiceServer) RemoveContact(context.Context, *user.RemoveContactRequest) (*user.RemoveContactResponse, error)
func (UnimplementedServiceServer) Search ¶
func (UnimplementedServiceServer) Search(context.Context, *user.SearchRequest) (*user.SearchResponse, error)
func (UnimplementedServiceServer) Update ¶
func (UnimplementedServiceServer) Update(context.Context, *user.UpdateRequest) (*user.UpdateResponse, error)
func (UnimplementedServiceServer) UpdateSettings ¶
func (UnimplementedServiceServer) UpdateSettings(context.Context, *user.UpdateSettingsRequest) (*user.UpdateSettingsResponse, error)
func (UnimplementedServiceServer) UploadProfileImage ¶
func (UnimplementedServiceServer) UploadProfileImage(grpc.ClientStreamingServer[user.UploadProfileImageRequest, user.UploadProfileImageResponse]) error
type UnsafeServiceServer ¶
type UnsafeServiceServer interface {
// contains filtered or unexported methods
}
UnsafeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceServer will result in compilation errors.
Source Files
¶
- service_grpc.pb.go