models

Documentation

Index

• Constants
• func ListNotificationIds(notifications []Notification) (ids []cmb.Id)
• type AddNotificationParams
• type AddNotificationResult
• type AddNotificationSParams
• type AddNotificationSResult
• type CountUnreadNotificationsParams
• type CountUnreadNotificationsResult
• type DeleteNotificationParams
• type DeleteNotificationResult
• type GetDKeyParams
• type GetDKeyResult
• type GetNotificationParams
• type GetNotificationResult
• type GetNotificationsOnPageParams
• type GetNotificationsOnPageResult
• type GetNotificationsParams
• type GetNotificationsResult
• type GetUnreadNotificationsParams
• type GetUnreadNotificationsResult
• type MarkNotificationAsReadParams
• type MarkNotificationAsReadResult
• type Notification
  • func NewNotification() (n *Notification)
  • func NewNotificationArrayFromRows(rows *sql.Rows) (ns []Notification, err error)
  • func NewNotificationFromScannableSource(src cm.IScannable) (n *Notification, err error)
• type NotificationsOnPage
  • func NewNotificationsOnPage() (nop *NotificationsOnPage)
• type PingParams
• type PingResult
• type ShowDiagnosticDataParams
• type ShowDiagnosticDataResult
• type TestParams
• type TestResult

Constants

const (
	ErrUnexpectedNull = "unexpected null"
)

Functions

func ListNotificationIds

func ListNotificationIds(notifications []Notification) (ids []cmb.Id)

Types

type AddNotificationParams

type AddNotificationParams struct {
	cmr.CommonParams
	UserId cmb.Id   `json:"userId"`
	Text   cmb.Text `json:"text"`
}

type AddNotificationResult

type AddNotificationResult struct {
	cmr.CommonResult

	// ID of the created notification.
	NotificationId cmb.Id `json:"notificationId"`
}

type AddNotificationSParams

type AddNotificationSParams struct {
	cmr.CommonParams
	cmr.DKeyParams
	UserId cmb.Id   `json:"userId"`
	Text   cmb.Text `json:"text"`
}

type AddNotificationSResult

type AddNotificationSResult struct {
	cmr.CommonResult

	// ID of the created notification.
	NotificationId cmb.Id `json:"notificationId"`
}

type CountUnreadNotificationsParams

type CountUnreadNotificationsParams struct {
	cmr.CommonParams
}

type CountUnreadNotificationsResult

type CountUnreadNotificationsResult struct {
	cmr.CommonResult
	UNC cmb.Count `json:"unc"`
}

type DeleteNotificationParams

type DeleteNotificationParams struct {
	cmr.CommonParams
	NotificationId cmb.Id `json:"notificationId"`
}

type DeleteNotificationResult

type DeleteNotificationResult = cmr.CommonResultWithSuccess

type GetDKeyParams

type GetDKeyParams struct {
	cmr.CommonParams
}

type GetDKeyResult

type GetDKeyResult struct {
	cmr.CommonResult
	DKey cmb.Text `json:"dKey"`
}

type GetNotificationParams

type GetNotificationParams struct {
	cmr.CommonParams
	NotificationId cmb.Id `json:"notificationId"`
}

type GetNotificationResult

type GetNotificationResult struct {
	cmr.CommonResult
	Notification *Notification `json:"notification"`
}

type GetNotificationsOnPageParams

type GetNotificationsOnPageParams struct {
	cmr.CommonParams
	Page cmb.Count `json:"page"`
}

type GetNotificationsOnPageResult

type GetNotificationsOnPageResult struct {
	cmr.CommonResult
	NotificationsOnPage *NotificationsOnPage `json:"nop"`
}

type GetNotificationsParams

type GetNotificationsParams struct {
	cmr.CommonParams
}

type GetNotificationsResult

type GetNotificationsResult struct {
	cmr.CommonResult
	NotificationIds *ul.UidList    `json:"notificationIds"`
	Notifications   []Notification `json:"notifications"`
}

type GetUnreadNotificationsParams

type GetUnreadNotificationsParams struct {
	cmr.CommonParams
}

type GetUnreadNotificationsResult

type GetUnreadNotificationsResult struct {
	cmr.CommonResult
	NotificationIds *ul.UidList    `json:"notificationIds"`
	Notifications   []Notification `json:"notifications"`
}

type MarkNotificationAsReadParams

type MarkNotificationAsReadParams struct {
	cmr.CommonParams

	// Identifier of a notification.
	NotificationId cmb.Id `json:"notificationId"`
}

type MarkNotificationAsReadResult

type MarkNotificationAsReadResult = cmr.CommonResultWithSuccess

type Notification

type Notification struct {
	// Identifier of this notification.
	Id cmb.Id `json:"id"`

	// Identifier of a recipient user.
	UserId cmb.Id `json:"userId"`

	// Textual information of this notification.
	Text cmb.Text `json:"text"`

	// Time of creation.
	TimeOfCreation time.Time `json:"toc"`

	// Is the notification read by the recipient ?
	IsRead cmb.Flag `json:"isRead"`

	// Time of reading.
	TimeOfReading *time.Time `json:"tor"`
}

func NewNotification

func NewNotification() (n *Notification)

func NewNotificationArrayFromRows

func NewNotificationArrayFromRows(rows *sql.Rows) (ns []Notification, err error)

func NewNotificationFromScannableSource

func NewNotificationFromScannableSource(src cm.IScannable) (n *Notification, err error)

type NotificationsOnPage

type NotificationsOnPage struct {
	// Notification parameters. If pagination is used, these lists contain
	// information after the application of pagination.
	NotificationIds *ul.UidList    `json:"notificationIds"`
	Notifications   []Notification `json:"notifications"`
	PageData        *cmr.PageData  `json:"pageData,omitempty"`
}

func NewNotificationsOnPage

func NewNotificationsOnPage() (nop *NotificationsOnPage)

type PingParams

type PingParams = cmr.PingParams

type PingResult

type PingResult = cmr.PingResult

type ShowDiagnosticDataParams

type ShowDiagnosticDataParams struct{}

type ShowDiagnosticDataResult

type ShowDiagnosticDataResult struct {
	cmr.CommonResult
	cmr.RequestsCount
}

type TestParams

type TestParams struct {
	N uint `json:"n"`
}

type TestResult

type TestResult struct {
	cmr.CommonResult
}