usernotifications

Documentation

Overview

Package usernotifications provides a series of HTTP handlers for managing user notifications in a compatible database.

Index

• Constants
• Variables
• func ProvideService(_ context.Context, logger logging.Logger, cfg *Config, ...) (types.UserNotificationDataService, error)
• type Config
  • func (cfg *Config) ValidateWithContext(ctx context.Context) error

Constants

const (
	// UserNotificationIDURIParamKey is a standard string that we'll use to refer to user notification IDs with.
	UserNotificationIDURIParamKey = "userNotificationID"
)

Variables

var Providers = wire.NewSet(
	ProvideService,
)

Providers are our collection of what we provide to other services.

Functions

func ProvideService

func ProvideService(
	_ context.Context,
	logger logging.Logger,
	cfg *Config,
	encoder encoding.ServerEncoderDecoder,
	routeParamManager routing.RouteParamManager,
	publisherProvider messagequeue.PublisherProvider,
	tracerProvider tracing.TracerProvider,
	userNotificationDataManager types.UserNotificationDataManager,
) (types.UserNotificationDataService, error)

ProvideService builds a new UserNotificationsService.

Types

type Config

type Config struct {
	DataChangesTopicName string `json:"dataChangesTopicName,omitempty" toml:"data_changes_topic_name,omitempty"`
	// contains filtered or unexported fields
}

Config configures the service.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.