notifications

package
v2.87.1 Latest Latest
Warning

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

Go to latest
Published: Jun 5, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_strmprivacy_api_notifications_v1_notifications_v1_proto protoreflect.FileDescriptor
View Source
var NotificationsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "strmprivacy.api.notifications.v1.NotificationsService",
	HandlerType: (*NotificationsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SubscribeNotifications",
			Handler:    _NotificationsService_SubscribeNotifications_Handler,
		},
		{
			MethodName: "UnSubscribeNotifications",
			Handler:    _NotificationsService_UnSubscribeNotifications_Handler,
		},
		{
			MethodName: "ListSubscriptions",
			Handler:    _NotificationsService_ListSubscriptions_Handler,
		},
		{
			MethodName: "NotifySubscribers",
			Handler:    _NotificationsService_NotifySubscribers_Handler,
		},
		{
			MethodName: "ListNotifications",
			Handler:    _NotificationsService_ListNotifications_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ReceiveNotifications",
			Handler:       _NotificationsService_ReceiveNotifications_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "strmprivacy/api/notifications/v1/notifications_v1.proto",
}

NotificationsService_ServiceDesc is the grpc.ServiceDesc for NotificationsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterNotificationsServiceServer

func RegisterNotificationsServiceServer(s grpc.ServiceRegistrar, srv NotificationsServiceServer)

Types

type ListNotificationsRequest

type ListNotificationsRequest struct {

	// The user for which to list notifications.
	ExternalUserId string `protobuf:"bytes,1,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// The entity for which to list notifications.
	EntityRef *v1.GenericRef `protobuf:"bytes,2,opt,name=entity_ref,json=entityRef,proto3" json:"entity_ref,omitempty"`
	PageSize  int32          `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken string         `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListNotificationsRequest) Descriptor deprecated

func (*ListNotificationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationsRequest.ProtoReflect.Descriptor instead.

func (*ListNotificationsRequest) GetEntityRef

func (x *ListNotificationsRequest) GetEntityRef() *v1.GenericRef

func (*ListNotificationsRequest) GetExternalUserId

func (x *ListNotificationsRequest) GetExternalUserId() string

func (*ListNotificationsRequest) GetPageSize

func (x *ListNotificationsRequest) GetPageSize() int32

func (*ListNotificationsRequest) GetPageToken

func (x *ListNotificationsRequest) GetPageToken() string

func (*ListNotificationsRequest) ProtoMessage

func (*ListNotificationsRequest) ProtoMessage()

func (*ListNotificationsRequest) ProtoReflect

func (x *ListNotificationsRequest) ProtoReflect() protoreflect.Message

func (*ListNotificationsRequest) Reset

func (x *ListNotificationsRequest) Reset()

func (*ListNotificationsRequest) String

func (x *ListNotificationsRequest) String() string

type ListNotificationsResponse

type ListNotificationsResponse struct {
	Notifications []*UserNotification `protobuf:"bytes,1,rep,name=notifications,proto3" json:"notifications,omitempty"`
	NextPageToken string              `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListNotificationsResponse) Descriptor deprecated

func (*ListNotificationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationsResponse.ProtoReflect.Descriptor instead.

func (*ListNotificationsResponse) GetNextPageToken

func (x *ListNotificationsResponse) GetNextPageToken() string

func (*ListNotificationsResponse) GetNotifications

func (x *ListNotificationsResponse) GetNotifications() []*UserNotification

func (*ListNotificationsResponse) ProtoMessage

func (*ListNotificationsResponse) ProtoMessage()

func (*ListNotificationsResponse) ProtoReflect

func (*ListNotificationsResponse) Reset

func (x *ListNotificationsResponse) Reset()

func (*ListNotificationsResponse) String

func (x *ListNotificationsResponse) String() string

type ListSubscriptionsRequest

type ListSubscriptionsRequest struct {

	// The user for which to list subscriptions.
	// ignored unless it's a system call
	ExternalUserId string `protobuf:"bytes,1,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSubscriptionsRequest) Descriptor deprecated

func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsRequest) GetExternalUserId

func (x *ListSubscriptionsRequest) GetExternalUserId() string

func (*ListSubscriptionsRequest) ProtoMessage

func (*ListSubscriptionsRequest) ProtoMessage()

func (*ListSubscriptionsRequest) ProtoReflect

func (x *ListSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*ListSubscriptionsRequest) Reset

func (x *ListSubscriptionsRequest) Reset()

func (*ListSubscriptionsRequest) String

func (x *ListSubscriptionsRequest) String() string

type ListSubscriptionsResponse

type ListSubscriptionsResponse struct {
	Subscriptions []*Subscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSubscriptionsResponse) Descriptor deprecated

func (*ListSubscriptionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsResponse) GetSubscriptions

func (x *ListSubscriptionsResponse) GetSubscriptions() []*Subscription

func (*ListSubscriptionsResponse) ProtoMessage

func (*ListSubscriptionsResponse) ProtoMessage()

func (*ListSubscriptionsResponse) ProtoReflect

func (*ListSubscriptionsResponse) Reset

func (x *ListSubscriptionsResponse) Reset()

func (*ListSubscriptionsResponse) String

func (x *ListSubscriptionsResponse) String() string

type Notification

type Notification struct {
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Types that are assignable to Notification:
	//
	//	*Notification_Comment
	//	*Notification_AuditTrailEntry
	Notification isNotification_Notification `protobuf_oneof:"notification"`
	// contains filtered or unexported fields
}

func (*Notification) Descriptor deprecated

func (*Notification) Descriptor() ([]byte, []int)

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

func (*Notification) GetAuditTrailEntry

func (x *Notification) GetAuditTrailEntry() *v1.AuditTrailEntry

func (*Notification) GetComment

func (x *Notification) GetComment() *v1.Comment

func (*Notification) GetCreateTime

func (x *Notification) GetCreateTime() *timestamppb.Timestamp

func (*Notification) GetNotification

func (m *Notification) GetNotification() isNotification_Notification

func (*Notification) ProtoMessage

func (*Notification) ProtoMessage()

func (*Notification) ProtoReflect

func (x *Notification) ProtoReflect() protoreflect.Message

func (*Notification) Reset

func (x *Notification) Reset()

func (*Notification) String

func (x *Notification) String() string

type Notification_AuditTrailEntry

type Notification_AuditTrailEntry struct {
	AuditTrailEntry *v1.AuditTrailEntry `protobuf:"bytes,3,opt,name=audit_trail_entry,json=auditTrailEntry,proto3,oneof"`
}

type Notification_Comment

type Notification_Comment struct {
	Comment *v1.Comment `protobuf:"bytes,2,opt,name=comment,proto3,oneof"`
}

type NotificationsServiceClient

type NotificationsServiceClient interface {
	// Tell the notification service that the given user should receive notifications about the given entity.
	SubscribeNotifications(ctx context.Context, in *SubscribeNotificationsRequest, opts ...grpc.CallOption) (*SubscribeNotificationsResponse, error)
	// Tell the notification service that the given user should *not* receive notifications about the given entity.
	UnSubscribeNotifications(ctx context.Context, in *UnSubscribeNotificationsRequest, opts ...grpc.CallOption) (*UnSubscribeNotificationsResponse, error)
	// List the subscriptions of a certain user.
	ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*ListSubscriptionsResponse, error)
	// Called by systems (schema-registry for instance) that want to notify subscribed users about something.
	NotifySubscribers(ctx context.Context, in *NotifySubscribersRequest, opts ...grpc.CallOption) (*NotifySubscribersResponse, error)
	// Called by the user's browser to receive notifications.
	ReceiveNotifications(ctx context.Context, in *ReceiveNotificationsRequest, opts ...grpc.CallOption) (NotificationsService_ReceiveNotificationsClient, error)
	// List notifications for a user.
	ListNotifications(ctx context.Context, in *ListNotificationsRequest, opts ...grpc.CallOption) (*ListNotificationsResponse, error)
}

NotificationsServiceClient is the client API for NotificationsService 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.

type NotificationsServiceServer

type NotificationsServiceServer interface {
	// Tell the notification service that the given user should receive notifications about the given entity.
	SubscribeNotifications(context.Context, *SubscribeNotificationsRequest) (*SubscribeNotificationsResponse, error)
	// Tell the notification service that the given user should *not* receive notifications about the given entity.
	UnSubscribeNotifications(context.Context, *UnSubscribeNotificationsRequest) (*UnSubscribeNotificationsResponse, error)
	// List the subscriptions of a certain user.
	ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*ListSubscriptionsResponse, error)
	// Called by systems (schema-registry for instance) that want to notify subscribed users about something.
	NotifySubscribers(context.Context, *NotifySubscribersRequest) (*NotifySubscribersResponse, error)
	// Called by the user's browser to receive notifications.
	ReceiveNotifications(*ReceiveNotificationsRequest, NotificationsService_ReceiveNotificationsServer) error
	// List notifications for a user.
	ListNotifications(context.Context, *ListNotificationsRequest) (*ListNotificationsResponse, error)
}

NotificationsServiceServer is the server API for NotificationsService service. All implementations should embed UnimplementedNotificationsServiceServer for forward compatibility

type NotificationsService_ReceiveNotificationsClient

type NotificationsService_ReceiveNotificationsClient interface {
	Recv() (*ReceiveNotificationsResponse, error)
	grpc.ClientStream
}

type NotificationsService_ReceiveNotificationsServer

type NotificationsService_ReceiveNotificationsServer interface {
	Send(*ReceiveNotificationsResponse) error
	grpc.ServerStream
}

type NotifySubscribersRequest

type NotifySubscribersRequest struct {

	// The entity that the notification is about
	EntityRef    *v1.GenericRef `protobuf:"bytes,1,opt,name=entity_ref,json=entityRef,proto3" json:"entity_ref,omitempty"`
	Notification *Notification  `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
	// contains filtered or unexported fields
}

Users subscribed to notifications about the given entity will receive the given notification.

func (*NotifySubscribersRequest) Descriptor deprecated

func (*NotifySubscribersRequest) Descriptor() ([]byte, []int)

Deprecated: Use NotifySubscribersRequest.ProtoReflect.Descriptor instead.

func (*NotifySubscribersRequest) GetEntityRef

func (x *NotifySubscribersRequest) GetEntityRef() *v1.GenericRef

func (*NotifySubscribersRequest) GetNotification

func (x *NotifySubscribersRequest) GetNotification() *Notification

func (*NotifySubscribersRequest) ProtoMessage

func (*NotifySubscribersRequest) ProtoMessage()

func (*NotifySubscribersRequest) ProtoReflect

func (x *NotifySubscribersRequest) ProtoReflect() protoreflect.Message

func (*NotifySubscribersRequest) Reset

func (x *NotifySubscribersRequest) Reset()

func (*NotifySubscribersRequest) String

func (x *NotifySubscribersRequest) String() string

type NotifySubscribersResponse

type NotifySubscribersResponse struct {
	// contains filtered or unexported fields
}

func (*NotifySubscribersResponse) Descriptor deprecated

func (*NotifySubscribersResponse) Descriptor() ([]byte, []int)

Deprecated: Use NotifySubscribersResponse.ProtoReflect.Descriptor instead.

func (*NotifySubscribersResponse) ProtoMessage

func (*NotifySubscribersResponse) ProtoMessage()

func (*NotifySubscribersResponse) ProtoReflect

func (*NotifySubscribersResponse) Reset

func (x *NotifySubscribersResponse) Reset()

func (*NotifySubscribersResponse) String

func (x *NotifySubscribersResponse) String() string

type ReceiveNotificationsRequest

type ReceiveNotificationsRequest struct {
	// contains filtered or unexported fields
}

The user's browser will subscribe to a stream to receive notifications. The user follows from the JWT.

func (*ReceiveNotificationsRequest) Descriptor deprecated

func (*ReceiveNotificationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReceiveNotificationsRequest.ProtoReflect.Descriptor instead.

func (*ReceiveNotificationsRequest) ProtoMessage

func (*ReceiveNotificationsRequest) ProtoMessage()

func (*ReceiveNotificationsRequest) ProtoReflect

func (*ReceiveNotificationsRequest) Reset

func (x *ReceiveNotificationsRequest) Reset()

func (*ReceiveNotificationsRequest) String

func (x *ReceiveNotificationsRequest) String() string

type ReceiveNotificationsResponse

type ReceiveNotificationsResponse struct {
	Notification *UserNotification `protobuf:"bytes,1,opt,name=notification,proto3" json:"notification,omitempty"`
	// contains filtered or unexported fields
}

func (*ReceiveNotificationsResponse) Descriptor deprecated

func (*ReceiveNotificationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReceiveNotificationsResponse.ProtoReflect.Descriptor instead.

func (*ReceiveNotificationsResponse) GetNotification

func (x *ReceiveNotificationsResponse) GetNotification() *UserNotification

func (*ReceiveNotificationsResponse) ProtoMessage

func (*ReceiveNotificationsResponse) ProtoMessage()

func (*ReceiveNotificationsResponse) ProtoReflect

func (*ReceiveNotificationsResponse) Reset

func (x *ReceiveNotificationsResponse) Reset()

func (*ReceiveNotificationsResponse) String

type SubscribeNotificationsRequest

type SubscribeNotificationsRequest struct {

	// The user that should be subscribed.
	ExternalUserId string `protobuf:"bytes,1,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// The entity for which the user should be subscribed to notifications.
	EntityRef *v1.GenericRef `protobuf:"bytes,2,opt,name=entity_ref,json=entityRef,proto3" json:"entity_ref,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeNotificationsRequest) Descriptor deprecated

func (*SubscribeNotificationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeNotificationsRequest.ProtoReflect.Descriptor instead.

func (*SubscribeNotificationsRequest) GetEntityRef

func (x *SubscribeNotificationsRequest) GetEntityRef() *v1.GenericRef

func (*SubscribeNotificationsRequest) GetExternalUserId

func (x *SubscribeNotificationsRequest) GetExternalUserId() string

func (*SubscribeNotificationsRequest) ProtoMessage

func (*SubscribeNotificationsRequest) ProtoMessage()

func (*SubscribeNotificationsRequest) ProtoReflect

func (*SubscribeNotificationsRequest) Reset

func (x *SubscribeNotificationsRequest) Reset()

func (*SubscribeNotificationsRequest) String

type SubscribeNotificationsResponse

type SubscribeNotificationsResponse struct {
	// contains filtered or unexported fields
}

func (*SubscribeNotificationsResponse) Descriptor deprecated

func (*SubscribeNotificationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SubscribeNotificationsResponse.ProtoReflect.Descriptor instead.

func (*SubscribeNotificationsResponse) ProtoMessage

func (*SubscribeNotificationsResponse) ProtoMessage()

func (*SubscribeNotificationsResponse) ProtoReflect

func (*SubscribeNotificationsResponse) Reset

func (x *SubscribeNotificationsResponse) Reset()

func (*SubscribeNotificationsResponse) String

type Subscription

type Subscription struct {

	// The subscribed user.
	ExternalUserId string `protobuf:"bytes,1,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// The entity for which to list notifications.
	EntityRef *v1.GenericRef `protobuf:"bytes,2,opt,name=entity_ref,json=entityRef,proto3" json:"entity_ref,omitempty"`
	// contains filtered or unexported fields
}

func (*Subscription) Descriptor deprecated

func (*Subscription) Descriptor() ([]byte, []int)

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetEntityRef

func (x *Subscription) GetEntityRef() *v1.GenericRef

func (*Subscription) GetExternalUserId

func (x *Subscription) GetExternalUserId() string

func (*Subscription) ProtoMessage

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect

func (x *Subscription) ProtoReflect() protoreflect.Message

func (*Subscription) Reset

func (x *Subscription) Reset()

func (*Subscription) String

func (x *Subscription) String() string

type UnSubscribeNotificationsRequest

type UnSubscribeNotificationsRequest struct {

	// The user that should be unsubscribed.
	ExternalUserId string `protobuf:"bytes,1,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// The entity for which the user should be unsubscribed from notifications.
	EntityRef *v1.GenericRef `protobuf:"bytes,2,opt,name=entity_ref,json=entityRef,proto3" json:"entity_ref,omitempty"`
	// contains filtered or unexported fields
}

* Tell the notification server that

user X is interested in receiving notifications about item Y

func (*UnSubscribeNotificationsRequest) Descriptor deprecated

func (*UnSubscribeNotificationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UnSubscribeNotificationsRequest.ProtoReflect.Descriptor instead.

func (*UnSubscribeNotificationsRequest) GetEntityRef

func (x *UnSubscribeNotificationsRequest) GetEntityRef() *v1.GenericRef

func (*UnSubscribeNotificationsRequest) GetExternalUserId

func (x *UnSubscribeNotificationsRequest) GetExternalUserId() string

func (*UnSubscribeNotificationsRequest) ProtoMessage

func (*UnSubscribeNotificationsRequest) ProtoMessage()

func (*UnSubscribeNotificationsRequest) ProtoReflect

func (*UnSubscribeNotificationsRequest) Reset

func (*UnSubscribeNotificationsRequest) String

type UnSubscribeNotificationsResponse

type UnSubscribeNotificationsResponse struct {
	// contains filtered or unexported fields
}

func (*UnSubscribeNotificationsResponse) Descriptor deprecated

func (*UnSubscribeNotificationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use UnSubscribeNotificationsResponse.ProtoReflect.Descriptor instead.

func (*UnSubscribeNotificationsResponse) ProtoMessage

func (*UnSubscribeNotificationsResponse) ProtoMessage()

func (*UnSubscribeNotificationsResponse) ProtoReflect

func (*UnSubscribeNotificationsResponse) Reset

func (*UnSubscribeNotificationsResponse) String

type UnimplementedNotificationsServiceServer

type UnimplementedNotificationsServiceServer struct {
}

UnimplementedNotificationsServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedNotificationsServiceServer) ListNotifications

func (UnimplementedNotificationsServiceServer) ListSubscriptions

func (UnimplementedNotificationsServiceServer) NotifySubscribers

type UnsafeNotificationsServiceServer

type UnsafeNotificationsServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeNotificationsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotificationsServiceServer will result in compilation errors.

type UserNotification

type UserNotification struct {
	Id           string        `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Notification *Notification `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
	// The reason a specific receiver of this notification received it.
	Reason         string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`
	ExternalUserId string `protobuf:"bytes,4,opt,name=external_user_id,json=externalUserId,proto3" json:"external_user_id,omitempty"`
	// mail was sent at this moment. If null|0, mail was not sent.
	MailSentTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=mail_sent_time,json=mailSentTime,proto3" json:"mail_sent_time,omitempty"`
	// contains filtered or unexported fields
}

The actual notification to be sent to an individual user.

func (*UserNotification) Descriptor deprecated

func (*UserNotification) Descriptor() ([]byte, []int)

Deprecated: Use UserNotification.ProtoReflect.Descriptor instead.

func (*UserNotification) GetExternalUserId

func (x *UserNotification) GetExternalUserId() string

func (*UserNotification) GetId

func (x *UserNotification) GetId() string

func (*UserNotification) GetMailSentTime

func (x *UserNotification) GetMailSentTime() *timestamppb.Timestamp

func (*UserNotification) GetNotification

func (x *UserNotification) GetNotification() *Notification

func (*UserNotification) GetReason

func (x *UserNotification) GetReason() string

func (*UserNotification) ProtoMessage

func (*UserNotification) ProtoMessage()

func (*UserNotification) ProtoReflect

func (x *UserNotification) ProtoReflect() protoreflect.Message

func (*UserNotification) Reset

func (x *UserNotification) Reset()

func (*UserNotification) String

func (x *UserNotification) String() string

Jump to

Keyboard shortcuts

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