notifications

package module

Go to main page

Versions in this module

v0

v0.3.0

May 13, 2026

Changes in this version

type Note

+ PushBody map[string]string

type PushMessage

+ Body string

v0.2.0

May 8, 2026

Changes in this version

+ type EmailUser struct

+ Email string

+ UserID int

+ type EventMetadata struct

+ CreatedAt string

+ ScheduledAt *string

+ TraceID string

+ UserID int

type PushMessage

+ Devices []string

+ NoteID int

+ Title string

+ type PushUser struct

+ Devices []string

+ Language string

+ UserID int

type Recipient

+ EmailUsers []EmailUser

+ StudentID int

+ Users []PushUser

type SMSMessage

+ NoteID int

type WhatsAppMessage

+ NoteID int

v0.1.0

May 7, 2026

Changes in this version

+ const DefaultTopicDLQ

+ const DefaultTopicEmailBatch

+ const DefaultTopicNoteCreated

+ const DefaultTopicNoteCreatedPriority

+ const DefaultTopicPushBatch

+ const DefaultTopicRetry

+ const DefaultTopicSMSBatch

+ const DefaultTopicWhatsAppBatch

+ const EventNoteCreated

+ const SchemaVersion

+ type Attachment struct

+ Filename string

+ Path string

+ URL *string

+ type Client struct

+ func NewClient(cfg Config) (*Client, error)

+ func NewClientWithProducer(p Producer, topics Topics) *Client

+ func (c *Client) Close() error

+ func (c *Client) PublishEmail(ctx context.Context, m EmailMessage) error

+ func (c *Client) PublishNoteCreated(ctx context.Context, n NoteCreated) error

+ func (c *Client) PublishPush(ctx context.Context, m PushMessage) error

+ func (c *Client) PublishRaw(ctx context.Context, topic, key string, payload any, headers map[string]string) error

+ func (c *Client) PublishSMS(ctx context.Context, m SMSMessage) error

+ func (c *Client) PublishWhatsApp(ctx context.Context, m WhatsAppMessage) error

+ func (c *Client) Topics() Topics

+ type Config struct

+ Async bool

+ BatchSize int

+ BatchTimeout time.Duration

+ Brokers string

+ ClientID string

+ Enabled bool

+ RequireAll bool

+ Topics Topics

+ WriteTimeout time.Duration

+ func ConfigFromEnv() Config

+ type EmailAttachment struct

+ Filename string

+ URL *string

+ type EmailMessage struct

+ Attachments []EmailAttachment

+ Content string

+ Email string

+ EventID string

+ FeaturedImage *string

+ FromName *string

+ NoteID *int64

+ Priority Priority

+ SchoolID int64

+ Signature *string

+ StudentID *int64

+ Subject string

+ TraceID string

+ UserID int64

+ type Metadata struct

+ CreatedAt string

+ ScheduledAt *string

+ TraceID string

+ UserID *int64

+ type Note struct

+ Channels []string

+ Content string

+ FeaturedImage *string

+ FromName *string

+ Important bool

+ NoteID int64

+ PushTitle PushTitle

+ RelativeTypeID *int64

+ SchoolID int64

+ Signature *string

+ Subject string

+ Title string

+ type NoteCreated struct

+ Attachments []Attachment

+ EventID string

+ EventType string

+ Metadata Metadata

+ Note Note

+ Recipient Recipient

+ Timestamp string

+ Version string

+ type Priority string

+ const PriorityHigh

+ const PriorityNormal

+ type Producer interface

+ Close func() error

+ Produce func(ctx context.Context, topic string, key string, payload any, ...) error

+ type PushMessage struct

+ BodyEN string

+ BodyES string

+ Data map[string]any

+ DeviceIDs []string

+ EventID string

+ ImageURL *string

+ Priority Priority

+ SchoolID int64

+ StudentID *int64

+ TitleEN string

+ TitleES string

+ TraceID string

+ UserID int64

+ type PushTitle struct

+ EN *string

+ ES *string

+ type Recipient map[string]any

+ type SMSMessage struct

+ Body string

+ EventID string

+ Phone string

+ Priority Priority

+ SchoolID int64

+ StudentID *int64

+ TraceID string

+ UserID int64

+ type Topics struct

+ DLQ string

+ EmailBatch string

+ NoteCreated string

+ NoteCreatedPriority string

+ PushBatch string

+ Retry string

+ SMSBatch string

+ WhatsAppBatch string

+ type WhatsAppMessage struct

+ EventID string

+ Phone string

+ Priority Priority

+ SchoolID int64

+ StudentID *int64

+ Text string

+ TraceID string

+ UserID int64

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