events

Documentation

Index

• Constants
• type Event
  • func NewEvent(meta EventMetadata) Event
  • func (e *Event) AddNewValue(column string, v EventDataValue)
  • func (e *Event) AddOldValue(column string, v EventDataValue)
  • func (e *Event) Change(column string) (ec *EventChange)
  • func (e Event) ChangedColumns() []string
  • func (e Event) HasChangedColumn(c string) bool
• type EventChange
  • func (ec *EventChange) NewValueAs(data interface{}) error
  • func (ec *EventChange) OldValueAs(data interface{}) error
  • func (ec *EventChange) SetNewValue(value interface{}) error
  • func (ec *EventChange) SetOldValue(value interface{}) error
• type EventDataValue
• type EventMetadata
• type EventType

Constants

const (
	// EventTypeCreated ...
	EventTypeCreated = "CREATED"
	// EventTypeUpdated ...
	EventTypeUpdated = "UPDATED"
	// EventTypeDeleted ...
	EventTypeDeleted = "DELETED"
)

Types

type Event

type Event struct {
	EventMetadata
	ID        string                    `json:"id"`
	Changes   []*EventChange            `json:"changes"`
	OldValues map[string]EventDataValue `json:"oldValues"`
	NewValues map[string]EventDataValue `json:"newValues"`
}

Event ...

func NewEvent

func NewEvent(meta EventMetadata) Event

NewEvent ...

func (*Event) AddNewValue

func (e *Event) AddNewValue(column string, v EventDataValue)

AddNewValue ...

func (*Event) AddOldValue

func (e *Event) AddOldValue(column string, v EventDataValue)

AddOldValue ...

func (*Event) Change

func (e *Event) Change(column string) (ec *EventChange)

func (Event) ChangedColumns

func (e Event) ChangedColumns() []string

ChangedColumns returns list of names of changed columns

func (Event) HasChangedColumn

func (e Event) HasChangedColumn(c string) bool

HasChangedColumn check if given event has changes on specific column

type EventChange

type EventChange struct {
	Name     string `json:"name"`
	OldValue string `json:"oldValue"`
	NewValue string `json:"newValue"`
}

EventChange ...

func (*EventChange) NewValueAs

func (ec *EventChange) NewValueAs(data interface{}) error

func (*EventChange) OldValueAs

func (ec *EventChange) OldValueAs(data interface{}) error

func (*EventChange) SetNewValue

func (ec *EventChange) SetNewValue(value interface{}) error

func (*EventChange) SetOldValue

func (ec *EventChange) SetOldValue(value interface{}) error

type EventDataValue

type EventDataValue interface{}

type EventMetadata

type EventMetadata struct {
	Type        EventType `json:"type"`
	Entity      string    `json:"entity"`
	EntityID    string    `json:"entityId"`
	Date        time.Time `json:"date"`
	PrincipalID *string   `json:"principalId"`
}

type EventType

type EventType string

EventType ...