http

Documentation

Index

• type NotificationController
  • func NewNotificationController(dic *di.Container) *NotificationController
  • func (nc *NotificationController) AddNotification(c echo.Context) error
  • func (nc *NotificationController) CleanupNotifications(c echo.Context) error
  • func (nc *NotificationController) CleanupNotificationsByAge(c echo.Context) error
  • func (nc *NotificationController) DeleteNotificationById(c echo.Context) error
  • func (nc *NotificationController) DeleteProcessedNotificationsByAge(c echo.Context) error
  • func (nc *NotificationController) NotificationById(c echo.Context) error
  • func (nc *NotificationController) NotificationsByCategory(c echo.Context) error
  • func (nc *NotificationController) NotificationsByLabel(c echo.Context) error
  • func (nc *NotificationController) NotificationsByStatus(c echo.Context) error
  • func (nc *NotificationController) NotificationsBySubscriptionName(c echo.Context) error
  • func (nc *NotificationController) NotificationsByTimeRange(c echo.Context) error
• type SubscriptionController
  • func NewSubscriptionController(dic *di.Container) *SubscriptionController
  • func (sc *SubscriptionController) AddSubscription(c echo.Context) error
  • func (sc *SubscriptionController) AllSubscriptions(c echo.Context) error
  • func (sc *SubscriptionController) DeleteSubscriptionByName(c echo.Context) error
  • func (sc *SubscriptionController) PatchSubscription(c echo.Context) error
  • func (sc *SubscriptionController) SubscriptionByName(c echo.Context) error
  • func (sc *SubscriptionController) SubscriptionsByCategory(c echo.Context) error
  • func (sc *SubscriptionController) SubscriptionsByLabel(c echo.Context) error
  • func (sc *SubscriptionController) SubscriptionsByReceiver(c echo.Context) error
• type TransmissionController
  • func NewTransmissionController(dic *di.Container) *TransmissionController
  • func (tc *TransmissionController) AllTransmissions(c echo.Context) error
  • func (nc *TransmissionController) DeleteProcessedTransmissionsByAge(c echo.Context) error
  • func (tc *TransmissionController) TransmissionById(c echo.Context) error
  • func (tc *TransmissionController) TransmissionsByNotificationId(c echo.Context) error
  • func (tc *TransmissionController) TransmissionsByStatus(c echo.Context) error
  • func (tc *TransmissionController) TransmissionsBySubscriptionName(c echo.Context) error
  • func (tc *TransmissionController) TransmissionsByTimeRange(c echo.Context) error

Types

type NotificationController

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

func NewNotificationController

func NewNotificationController(dic *di.Container) *NotificationController

NewNotificationController creates and initializes an NotificationController

func (*NotificationController) AddNotification

func (nc *NotificationController) AddNotification(c echo.Context) error

func (*NotificationController) CleanupNotifications

func (nc *NotificationController) CleanupNotifications(c echo.Context) error

CleanupNotifications deletes all notifications and the corresponding transmissions.

func (*NotificationController) CleanupNotificationsByAge

func (nc *NotificationController) CleanupNotificationsByAge(c echo.Context) error

CleanupNotificationsByAge deletes notifications which have age and is less than the specified one, where the age of Notification is calculated by subtracting its last modification timestamp from the current timestamp. Note that the corresponding transmissions will also be deleted.

func (*NotificationController) DeleteNotificationById

func (nc *NotificationController) DeleteNotificationById(c echo.Context) error

DeleteNotificationById deletes the notification by id and all of its associated transmissions

func (*NotificationController) DeleteProcessedNotificationsByAge

func (nc *NotificationController) DeleteProcessedNotificationsByAge(c echo.Context) error

DeleteProcessedNotificationsByAge deletes the processed notifications if the current timestamp minus their last modification timestamp is less than the age parameter, and the corresponding transmissions will also be deleted. Please notice that this API is only for processed notifications (status = PROCESSED). If the deletion purpose includes each kind of notifications, please refer to /cleanup API.

func (*NotificationController) NotificationById

func (nc *NotificationController) NotificationById(c echo.Context) error

func (*NotificationController) NotificationsByCategory

func (nc *NotificationController) NotificationsByCategory(c echo.Context) error

func (*NotificationController) NotificationsByLabel

func (nc *NotificationController) NotificationsByLabel(c echo.Context) error

func (*NotificationController) NotificationsByStatus

func (nc *NotificationController) NotificationsByStatus(c echo.Context) error

func (*NotificationController) NotificationsBySubscriptionName

func (nc *NotificationController) NotificationsBySubscriptionName(c echo.Context) error

NotificationsBySubscriptionName queries notifications by offset, limit and subscriptionName

func (*NotificationController) NotificationsByTimeRange

func (nc *NotificationController) NotificationsByTimeRange(c echo.Context) error

type SubscriptionController

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

func NewSubscriptionController

func NewSubscriptionController(dic *di.Container) *SubscriptionController

NewSubscriptionController creates and initializes an SubscriptionController

func (*SubscriptionController) AddSubscription

func (sc *SubscriptionController) AddSubscription(c echo.Context) error

func (*SubscriptionController) AllSubscriptions

func (sc *SubscriptionController) AllSubscriptions(c echo.Context) error

func (*SubscriptionController) DeleteSubscriptionByName

func (sc *SubscriptionController) DeleteSubscriptionByName(c echo.Context) error

func (*SubscriptionController) PatchSubscription

func (sc *SubscriptionController) PatchSubscription(c echo.Context) error

func (*SubscriptionController) SubscriptionByName

func (sc *SubscriptionController) SubscriptionByName(c echo.Context) error

func (*SubscriptionController) SubscriptionsByCategory

func (sc *SubscriptionController) SubscriptionsByCategory(c echo.Context) error

func (*SubscriptionController) SubscriptionsByLabel

func (sc *SubscriptionController) SubscriptionsByLabel(c echo.Context) error

func (*SubscriptionController) SubscriptionsByReceiver

func (sc *SubscriptionController) SubscriptionsByReceiver(c echo.Context) error

type TransmissionController

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

func NewTransmissionController

func NewTransmissionController(dic *di.Container) *TransmissionController

NewTransmissionController creates and initializes an TransmissionController

func (*TransmissionController) AllTransmissions

func (tc *TransmissionController) AllTransmissions(c echo.Context) error

func (*TransmissionController) DeleteProcessedTransmissionsByAge

func (nc *TransmissionController) DeleteProcessedTransmissionsByAge(c echo.Context) error

DeleteProcessedTransmissionsByAge deletes the processed transmissions if the current timestamp minus their created timestamp is less than the age parameter.

func (*TransmissionController) TransmissionById

func (tc *TransmissionController) TransmissionById(c echo.Context) error

TransmissionById queries transmission by ID

func (*TransmissionController) TransmissionsByNotificationId

func (tc *TransmissionController) TransmissionsByNotificationId(c echo.Context) error

TransmissionsByNotificationId queries transmission by Notification ID

func (*TransmissionController) TransmissionsByStatus

func (tc *TransmissionController) TransmissionsByStatus(c echo.Context) error

TransmissionsByStatus allows retrieval of the transmissions associated with the specified status. Ordered by create timestamp descending.

func (*TransmissionController) TransmissionsBySubscriptionName

func (tc *TransmissionController) TransmissionsBySubscriptionName(c echo.Context) error

TransmissionsBySubscriptionName allows retrieval of the transmissions associated with the specified subscription name. Ordered by create timestamp descending.

func (*TransmissionController) TransmissionsByTimeRange

func (tc *TransmissionController) TransmissionsByTimeRange(c echo.Context) error

TransmissionsByTimeRange allows querying of transmissions by their creation timestamp within a given time range, sorted in descending order. Results are paginated.