Documentation ¶
Index ¶
- Constants
- type Access
- func (a Access) Check(str string) bool
- func (a Access) Is(i Access) bool
- func (a Access) IsPrivate() bool
- func (a Access) IsProtected() bool
- func (a Access) IsPublic() bool
- func (a Access) MCheck(str string, mask Access) bool
- func (a Access) MarshalJSON() ([]byte, error)
- func (a Access) String() string
- func (a *Access) UnmarshalJSON(data []byte) (err error)
- type AccessJson
- type ModuleMeta
- type NameMeta
- type ResDecoder
- type ResourceAction
- type ResourceActivity
- type ResourceActivityFilter
- type ResourceActivityMeta
- type ResourceActivitySet
- func (set ResourceActivitySet) Filter(f func(*ResourceActivity) (bool, error)) (out ResourceActivitySet, err error)
- func (set ResourceActivitySet) FindByID(ID uint64) *ResourceActivity
- func (set ResourceActivitySet) IDs() (IDs []uint64)
- func (set ResourceActivitySet) Walk(w func(*ResourceActivity) error) (err error)
- type ResourceMeta
- type ResponseMeta
- type Result
Constants ¶
const ( Mask Access = 0b111 Private Access = 0b001 Protected Access = 0b010 Public Access = 0b100 PrivateLabel = "private" ProtectedLabel = "protected" PublicLabel = "public" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Access ¶
type Access int
func (Access) IsProtected ¶
func (Access) MarshalJSON ¶
func (*Access) UnmarshalJSON ¶
type AccessJson ¶
type AccessJson struct {
Result []Result `json:"result"`
}
type ModuleMeta ¶
type ModuleMeta struct { Public AccessJson `json:"public"` Private AccessJson `json:"private"` Protected AccessJson `json:"protected"` }
"discovery": { "public": { "result": [ { lang: "", // en, fr fields: [] // “names”, .. } ] } // struct }, "private": { "response": [] } }
type NameMeta ¶
type NameMeta struct { Name string `json:"name"` Title string `json:"title"` Weight int `json:"weight"` }
NameMeta is single row of discovery response fields with its weight
type ResDecoder ¶
type ResourceAction ¶
type ResourceAction string
ResourceAction determinants resource action event
const ( AfterCreate ResourceAction = "afterCreate" AfterUpdate ResourceAction = "afterUpdate" AfterDelete ResourceAction = "afterDelete" ResourceActivityResourceType = "corteza::generic:resource-activity" )
func (ResourceAction) String ¶
func (s ResourceAction) String() string
type ResourceActivity ¶
type ResourceActivity struct { ID uint64 `json:"activityID,string"` // ResourceID of the corteza resource ResourceID uint64 `json:"resourceID,string"` // ResourceType ResourceType string `json:"resourceType"` // ResourceAction Type of action ResourceAction string `json:"resourceAction"` // Timestamp of the raised event Timestamp time.Time `json:"timestamp"` // Meta of the related resources Meta types.JSONText `json:"meta"` }
ResourceActivity Standardized data structure for resource activity
func CastToResourceActivity ¶
func CastToResourceActivity(dec ResDecoder) (a *ResourceActivity, err error)
type ResourceActivityFilter ¶
type ResourceActivityFilter struct { FromTimestamp *time.Time `json:"from"` ToTimestamp *time.Time `json:"to"` // Check fn is called by store backend for each resource found function can // modify the activity and return false if store should not return it // // Store then loads additional resources to satisfy the paging parameters Check func(*ResourceActivity) (bool, error) `json:"-"` // Standard helpers for paging and sorting filter.Sorting filter.Paging }
type ResourceActivityMeta ¶
type ResourceActivitySet ¶
type ResourceActivitySet []*ResourceActivity
ResourceActivitySet slice of ResourceActivity
This type is auto-generated.
func (ResourceActivitySet) Filter ¶
func (set ResourceActivitySet) Filter(f func(*ResourceActivity) (bool, error)) (out ResourceActivitySet, err error)
Filter iterates through every slice item, calls f(ResourceActivity) (bool, err) and return filtered slice
This function is auto-generated.
func (ResourceActivitySet) FindByID ¶
func (set ResourceActivitySet) FindByID(ID uint64) *ResourceActivity
FindByID finds items from slice by its ID property
This function is auto-generated.
func (ResourceActivitySet) IDs ¶
func (set ResourceActivitySet) IDs() (IDs []uint64)
IDs returns a slice of uint64s from all items in the set
This function is auto-generated.
func (ResourceActivitySet) Walk ¶
func (set ResourceActivitySet) Walk(w func(*ResourceActivity) error) (err error)
Walk iterates through every slice item and calls w(ResourceActivity) err
This function is auto-generated.
type ResourceMeta ¶
type ResourceMeta struct { NamespaceMeta []NameMeta `json:"namespace_meta,omitempty"` ModuleMeta []NameMeta `json:"module_meta,omitempty"` RecordMeta []NameMeta `json:"record_meta,omitempty"` }
ResourceMeta have all resource related meta
for what to display in what order for each resource and its fields
type ResponseMeta ¶
type ResponseMeta struct { Private ResourceMeta `json:"private,omitempty"` Public ResourceMeta `json:"public,omitempty"` Protected ResourceMeta `json:"protected,omitempty"` }
ResponseMeta has all access restriction response