notification

Nov 19, 2024

Changes in this version

+ const MessageTypeSignalMessage

+ type DestID struct

+ CMID uuid.NullUUID

+ NCID uuid.NullUUID

+ func (d DestID) IsUserCM() bool

+ func (d DestID) String() string

+ func (d DestID) UUID() uuid.UUID

+ type SignalMessage = nfymsg.SignalMessage

Feb 9, 2024

Changes in this version

type AlertStatus

+ ServiceID string

Aug 25, 2023

Changes in this version

type Alert

+ ServiceID string

+ ServiceName string

type DestType

+ const DestTypeChanWebhook

+ const DestTypeSlackDM

+ const DestTypeSlackUG

type MessageLog

+ RetryCount int

+ SentAt *time.Time

type Result

+ const ResultEscalate

type Status

+ func (s Status) Age() time.Duration

type Store

+ func (s *Store) TimeSeries(ctx context.Context, opts TimeSeriesOpts) ([]TimeSeriesBucket, error)

+ type TimeSeriesBucket struct

+ Count int

+ End time.Time

+ Start time.Time

+ type TimeSeriesOpts struct

+ TimeSeriesInterval time.Duration

+ TimeSeriesOrigin time.Time

Nov 2, 2022

Changes in this version

+ type MessageLog struct

+ AlertID int

+ ChannelID uuid.UUID

+ ContactMethodID string

+ CreatedAt time.Time

+ ID string

+ LastStatus State

+ LastStatusAt time.Time

+ MessageType MessageType

+ ProviderMsgID *ProviderMessageID

+ ServiceID string

+ ServiceName string

+ SrcValue string

+ StatusDetails string

+ UserID string

+ UserName string

+ type SearchCursor struct

+ CreatedAt time.Time

+ ID string

+ type SearchOptions struct

+ After SearchCursor

+ CreatedAfter time.Time

+ CreatedBefore time.Time

+ Limit int

+ Omit []string

+ Search string

type Store

+ func (s *Store) Search(ctx context.Context, opts *SearchOptions) ([]MessageLog, error)

Sep 6, 2022

Changes in this version

type Dest

+ func DestFromPair(cm *contactmethod.ContactMethod, nc *notificationchannel.Channel) Dest

type Receiver

+ AuthLinkURL func(ctx context.Context, providerID, subjectID string, meta authlink.Metadata) (string, error)

type ResultReceiver

+ AuthLinkURL func(ctx context.Context, providerID, subjectID string, meta authlink.Metadata) (string, error)

type State

+ const StateBundled

+ func (s *State) Scan(value interface{}) error

type Store

+ func NewStore(ctx context.Context, db *sql.DB) (*Store, error)

+ type UnknownSubjectError struct

+ AlertID int

+ func (e UnknownSubjectError) Error() string

Dec 1, 2021

Changes in this version

+ var ErrUnknownSubject = errors.New("unknown subject for that provider")

+ type AlertPendingNotification struct

+ DestName string

+ DestType string

+ type AlertState int

+ const AlertStateAcknowledged

+ const AlertStateClosed

+ const AlertStateUnacknowledged

+ const AlertStateUnknown

type AlertStatus

+ NewAlertState AlertState

type DB

+ func (db *DB) FindPendingNotifications(ctx context.Context, alertID int) ([]AlertPendingNotification, error)

type ProviderMessageID

+ func ParseProviderMessageID(id string) (ProviderMessageID, error)

+ func (p ProviderMessageID) String() string

type Receiver

+ ReceiveSubject func(ctx context.Context, providerID, subjectID, callbackID string, result Result) error

type ResultReceiver

+ ReceiveSubject func(ctx context.Context, providerID, subjectID, callbackID string, result Result) error

type Status

+ SrcValue string

type Store

+ FindPendingNotifications func(ctx context.Context, alertID int) ([]AlertPendingNotification, error)

Aug 30, 2021

Changes in this version

type Alert

+ OriginalStatus *SendResult

type AlertStatus

+ Details string

+ NewAlertStatus alert.Status

+ OriginalStatus SendResult

+ Summary string

type DB

+ func (db *DB) OriginalMessageStatus(ctx context.Context, alertID int, dst Dest) (*SendResult, error)

type Dest

+ func (d Dest) String() string

type DestType

+ const DestTypeUserWebhook

+ func (t DestType) CMType() contactmethod.Type

+ func (t DestType) NCType() notificationchannel.Type

+ type FriendlyValuer interface

+ FriendlyValue func(context.Context, string) (string, error)

type Manager

+ func (mgr *Manager) FormatDestValue(ctx context.Context, destType DestType, value string) string

+ func (mgr *Manager) MessageStatus(ctx context.Context, messageID string, providerMsgID ProviderMessageID) (*Status, error)

+ func (mgr *Manager) SendMessage(ctx context.Context, msg Message) (*SendResult, error)

+ func (mgr *Manager) SetResultReceiver(p ResultReceiver)

type MessageType

+ const MessageTypeScheduleOnCallUsers

+ type ProviderMessageID struct

+ ExternalID string

+ ProviderName string

+ func (p *ProviderMessageID) Scan(value interface{}) error

+ func (p ProviderMessageID) Value() (driver.Value, error)

type Receiver

+ IsKnownDest func(ctx context.Context, value string) (bool, error)

+ SetMessageStatus func(ctx context.Context, externalID string, status *Status) error

+ type ResultReceiver interface

+ IsKnownDest func(ctx context.Context, destType DestType, destValue string) (bool, error)

+ Receive func(ctx context.Context, callbackID string, result Result) error

+ SetSendResult func(ctx context.Context, res *SendResult) error

+ Start func(context.Context, Dest) error

+ Stop func(context.Context, Dest) error

+ type ScannableDestType struct

+ CM contactmethod.Type

+ NC notificationchannel.Type

+ func (t ScannableDestType) DestType() DestType

+ type ScheduleOnCallUsers struct

+ CallbackID string

+ Dest Dest

+ ScheduleID string

+ ScheduleName string

+ ScheduleURL string

+ Users []User

+ func (s ScheduleOnCallUsers) Destination() Dest

+ func (s ScheduleOnCallUsers) ID() string

+ func (s ScheduleOnCallUsers) Type() MessageType

+ type SendResult struct

+ DestType DestType

+ ID string

+ ProviderMessageID ProviderMessageID

+ SrcValue string

+ type SentMessage struct

+ ExternalID string

+ SrcValue string

+ State State

+ StateDetails string

+ type State int

+ const StateDelivered

+ const StateFailedPerm

+ const StateFailedTemp

+ const StatePending

+ const StateSending

+ const StateSent

+ const StateUnknown

+ func (s State) IsOK() bool

+ type Status struct

+ Details string

+ Sequence int

+ State State

type Store

+ OriginalMessageStatus func(ctx context.Context, alertID int, dest Dest) (*SendResult, error)

+ type User struct

+ ID string

+ Name string

+ URL string

May 3, 2021

Changes in this version

+ var ErrStatusUnsupported = errors.New("status check unsupported by provider")

type DestType

+ const DestTypeUserEmail

type MessageType

+ const MessageTypeUnknown

+ type ReceiverSetter interface

+ SetReceiver func(Receiver)

+ type StatusChecker interface

+ Status func(ctx context.Context, messageID, providerMessageID string) (*MessageStatus, error)

Nov 3, 2020

Changes in this version

type DB

+ func (db *DB) LastMessageStatus(ctx context.Context, typ MessageType, cmID string, from time.Time) (*MessageStatus, time.Time, error)

type MessageType

+ func (s *MessageType) Scan(value interface{}) error

+ func (s MessageType) Value() (driver.Value, error)

type Store

+ LastMessageStatus func(ctx context.Context, typ MessageType, cmID string, from time.Time) (*MessageStatus, time.Time, error)

Jul 20, 2020

Changes in this version

type DB

+ func (db *DB) FindManyMessageStatuses(ctx context.Context, ids ...string) ([]MessageStatus, error)

type MessageState

+ const MessageStatePending

+ const MessageStateSending

type Receiver

+ Start func(context.Context, Dest) error

type Result

+ const ResultStart

type Store

+ FindManyMessageStatuses func(ctx context.Context, ids ...string) ([]MessageStatus, error)

Oct 30, 2019

Changes in this version

+ type AlertBundle struct

+ CallbackID string

+ Count int

+ Dest Dest

+ ServiceID string

+ ServiceName string

+ func (b AlertBundle) Destination() Dest

+ func (b AlertBundle) ID() string

+ func (b AlertBundle) Type() MessageType

type AlertStatus

+ CallbackID string

+ LogEntry string

+ type AlertStatusBundle struct

+ AlertID int

+ CallbackID string

+ Count int

+ Dest Dest

+ LogEntry string

+ func (b AlertStatusBundle) Destination() Dest

+ func (b AlertStatusBundle) ID() string

+ func (b AlertStatusBundle) Type() MessageType

type Dest

+ ID string

type MessageType

+ const MessageTypeAlertBundle

+ const MessageTypeAlertStatusBundle

Jun 7, 2019

Changes in this version

+ type Alert struct

+ AlertID int

+ CallbackID string

+ Dest Dest

+ Details string

+ Summary string

+ func (a Alert) Body() string

+ func (a Alert) Destination() Dest

+ func (a Alert) ExtendedBody() string

+ func (a Alert) ID() string

+ func (a Alert) SubjectID() int

+ func (a Alert) Type() MessageType

+ type AlertStatus struct

+ AlertID int

+ Dest Dest

+ Log string

+ MessageID string

+ func (s AlertStatus) Body() string

+ func (s AlertStatus) Destination() Dest

+ func (s AlertStatus) ExtendedBody() string

+ func (s AlertStatus) ID() string

+ func (s AlertStatus) SubjectID() int

+ func (s AlertStatus) Type() MessageType

+ type DB struct

+ func NewDB(ctx context.Context, db *sql.DB) (*DB, error)

+ func (db *DB) Code(ctx context.Context, id string) (int, error)

+ func (db *DB) CodeExpiration(ctx context.Context, id string) (t *time.Time, err error)

+ func (db *DB) SendContactMethodTest(ctx context.Context, id string) error

+ func (db *DB) SendContactMethodVerification(ctx context.Context, id string, resend bool) error

+ func (db *DB) VerifyContactMethod(ctx context.Context, cmID string, code int) ([]string, error)

+ type Dest struct

+ Type DestType

+ Value string

+ type DestType int

+ const DestTypeSMS

+ const DestTypeSlackChannel

+ const DestTypeUnknown

+ const DestTypeVoice

+ func (i DestType) String() string

+ func (t DestType) IsUserCM() bool

+ type Manager struct

+ func NewManager() *Manager

+ func (m *Manager) RegisterReceiver(r Receiver)

+ func (m *Manager) RegisterSender(t DestType, name string, s SendResponder)

+ func (m *Manager) Send(ctx context.Context, msg Message) (*MessageStatus, error)

+ func (m *Manager) Shutdown(context.Context) error

+ func (m *Manager) Status(ctx context.Context, id, providerMsgID string) (*MessageStatus, error)

+ func (mgr *Manager) SetStubNotifiers()

+ type Message interface

+ Body func() string

+ Destination func() Dest

+ ExtendedBody func() string

+ ID func() string

+ SubjectID func() int

+ Type func() MessageType

+ type MessageResponse struct

+ Ctx context.Context

+ Err chan error

+ From Dest

+ ID string

+ Result Result

+ type MessageState int

+ const MessageStateActive

+ const MessageStateDelivered

+ const MessageStateFailedPerm

+ const MessageStateFailedTemp

+ const MessageStateSent

+ type MessageStatus struct

+ Ctx context.Context

+ Details string

+ ID string

+ ProviderMessageID string

+ Sequence int

+ State MessageState

+ type MessageType int

+ const MessageTypeAlert

+ const MessageTypeAlertStatus

+ const MessageTypeTest

+ const MessageTypeVerification

+ func (i MessageType) String() string

+ type Receiver interface

+ Receive func(ctx context.Context, callbackID string, result Result) error

+ Stop func(context.Context, Dest) error

+ UpdateStatus func(context.Context, *MessageStatus) error

+ type Result int

+ const ResultAcknowledge

+ const ResultResolve

+ const ResultStop

+ func (i Result) String() string

+ type SendResponder interface

+ ListenResponse func() <-chan *MessageResponse

+ ListenStatus func() <-chan *MessageStatus

+ type Sender interface

+ Send func(context.Context, Message) (*MessageStatus, error)

+ Status func(ctx context.Context, id, providerID string) (*MessageStatus, error)

+ type Store interface

+ Code func(ctx context.Context, id string) (int, error)

+ CodeExpiration func(ctx context.Context, cmID string) (*time.Time, error)

+ SendContactMethodTest func(ctx context.Context, cmID string) error

+ SendContactMethodVerification func(ctx context.Context, cmID string, resend bool) error

+ VerifyContactMethod func(ctx context.Context, cmID string, code int) ([]string, error)

+ type Test struct

+ CallbackID string

+ Dest Dest

+ func (t Test) Body() string

+ func (t Test) Destination() Dest

+ func (t Test) ExtendedBody() string

+ func (t Test) ID() string

+ func (t Test) SubjectID() int

+ func (t Test) Type() MessageType

+ type Verification struct

+ CallbackID string

+ Code int

+ Dest Dest

+ func (v Verification) Body() string

+ func (v Verification) Destination() Dest

+ func (v Verification) ExtendedBody() string

+ func (v Verification) ID() string

+ func (v Verification) SubjectID() int

+ func (v Verification) Type() MessageType