group

Documentation

Index

• type Handler
  • func (h *Handler) Add(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) GetGroupMembers(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Groups(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) JoinGroup(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) LeaveGroup(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Update(w http.ResponseWriter, r *http.Request)
• type Store
  • func (s Store) Add(ctx domain.RequestContext, g group.Group) (err error)
  • func (s Store) Delete(ctx domain.RequestContext, refID string) (rows int64, err error)
  • func (s Store) Get(ctx domain.RequestContext, refID string) (g group.Group, err error)
  • func (s Store) GetAll(ctx domain.RequestContext) (groups []group.Group, err error)
  • func (s Store) GetGroupMembers(ctx domain.RequestContext, groupID string) (members []group.Member, err error)
  • func (s Store) GetMembers(ctx domain.RequestContext) (r []group.Record, err error)
  • func (s Store) JoinGroup(ctx domain.RequestContext, groupID, userID string) (err error)
  • func (s Store) LeaveGroup(ctx domain.RequestContext, groupID, userID string) (err error)
  • func (s Store) RemoveUserGroups(ctx domain.RequestContext, userID string) (err error)
  • func (s Store) Update(ctx domain.RequestContext, g group.Group) (err error)

Types

type Handler

type Handler struct {
	Runtime *env.Runtime
	Store   *store.Store
}

Handler contains the runtime information such as logging and database.

func (*Handler) Add

func (h *Handler) Add(w http.ResponseWriter, r *http.Request)

Add saves new user group.

func (*Handler) Delete

func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)

Delete removes group and associated member records.

func (*Handler) GetGroupMembers

func (h *Handler) GetGroupMembers(w http.ResponseWriter, r *http.Request)

GetGroupMembers returns all users associated with given group.

func (*Handler) Groups

func (h *Handler) Groups(w http.ResponseWriter, r *http.Request)

Groups returns all user groups for org.

func (*Handler) JoinGroup

func (h *Handler) JoinGroup(w http.ResponseWriter, r *http.Request)

JoinGroup adds user to group.

func (*Handler) LeaveGroup

func (h *Handler) LeaveGroup(w http.ResponseWriter, r *http.Request)

LeaveGroup removes user to group.

func (*Handler) Update

func (h *Handler) Update(w http.ResponseWriter, r *http.Request)

Update saves group name and description changes.

type Store

type Store struct {
	store.Context
	store.DocumentStorer
}

Store provides data access to space category information.

func (Store) Add

func (s Store) Add(ctx domain.RequestContext, g group.Group) (err error)

Add inserts new user group into store.

func (Store) Delete

func (s Store) Delete(ctx domain.RequestContext, refID string) (rows int64, err error)

Delete removes group from store.

func (Store) Get

func (s Store) Get(ctx domain.RequestContext, refID string) (g group.Group, err error)

Get returns requested group.

func (Store) GetAll

func (s Store) GetAll(ctx domain.RequestContext) (groups []group.Group, err error)

GetAll returns all user groups for current orgID.

func (Store) GetGroupMembers

func (s Store) GetGroupMembers(ctx domain.RequestContext, groupID string) (members []group.Member, err error)

GetGroupMembers returns all user associated with given group.

func (Store) GetMembers

func (s Store) GetMembers(ctx domain.RequestContext) (r []group.Record, err error)

GetMembers returns members for every group. Useful when you need to bulk fetch membership records for subsequent processing.

func (Store) JoinGroup

func (s Store) JoinGroup(ctx domain.RequestContext, groupID, userID string) (err error)

JoinGroup adds user to group.

func (Store) LeaveGroup

func (s Store) LeaveGroup(ctx domain.RequestContext, groupID, userID string) (err error)

LeaveGroup removes user from group.

func (Store) RemoveUserGroups

func (s Store) RemoveUserGroups(ctx domain.RequestContext, userID string) (err error)

RemoveUserGroups remove user from all group.

func (Store) Update

func (s Store) Update(ctx domain.RequestContext, g group.Group) (err error)

Update group name and description.