summary

package

v0.5.5 Latest Latest Go to latest Published: Jun 19, 2026 License: GPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nethesis/nethcti-middleware

Links

Open Source Insights

Documentation ¶

Index ¶

func IsSatelliteDBConfigured() bool
func SetSummaryNotifier(fn notifyFunc)
type CallMetadata
type SummaryMessage
- func (m SummaryMessage) TargetUsername() string
type WatchStartResult
- func StartSummaryWatch(uniqueID, username string) WatchStartResult
- func StartSummaryWatchWithLinkedID(uniqueID, linkedID, username string) WatchStartResult

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsSatelliteDBConfigured ¶

func IsSatelliteDBConfigured() bool

IsSatelliteDBConfigured checks whether the satellite DB configuration is present.

func SetSummaryNotifier ¶

func SetSummaryNotifier(fn notifyFunc)

SetSummaryNotifier sets the callback used to deliver summary notifications.

Types ¶

type CallMetadata ¶

type CallMetadata struct {
	Src     string
	Dst     string
	CNam    string
	DstCNam string
}

type SummaryMessage ¶

type SummaryMessage struct {
	UniqueID      string `json:"uniqueid"`
	LinkedID      string `json:"linkedid,omitempty"`
	DisplayName   string `json:"display_name,omitempty"`
	DisplayNumber string `json:"display_number,omitempty"`
	Username      string `json:"-"`
}

SummaryMessage represents the payload sent over WebSocket when a summary is available.

func (SummaryMessage) TargetUsername ¶

func (m SummaryMessage) TargetUsername() string

type WatchStartResult ¶

type WatchStartResult string

const (
	WatchStarted       WatchStartResult = "started"
	WatchAlreadyActive WatchStartResult = "already_active"
	WatchMisconfigured WatchStartResult = "misconfigured"
	WatchInvalidInput  WatchStartResult = "invalid_input"
)

func StartSummaryWatch ¶

func StartSummaryWatch(uniqueID, username string) WatchStartResult

StartSummaryWatch registers a watcher for the given user and unique ID. It returns a result that distinguishes whether the watcher started, was already active, or could not start.

func StartSummaryWatchWithLinkedID ¶ added in v0.5.3

func StartSummaryWatchWithLinkedID(uniqueID, linkedID, username string) WatchStartResult

StartSummaryWatchWithLinkedID registers a watcher and keeps the linked ID for the notification payload.

Source Files ¶

View all Source files

watcher.go

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