space

Documentation

Overview

Package space handles API calls and persistence for spaces. Spaces in Documize contain documents.

Index

• type Handler
  • func (h *Handler) AcceptInvitation(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Add(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Get(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) GetAll(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) GetViewable(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Invite(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Remove(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, sp space.Space) (err error)
  • func (s Store) Delete(ctx domain.RequestContext, id string) (rows int64, err error)
  • func (s Store) Get(ctx domain.RequestContext, id string) (sp space.Space, err error)
  • func (s Store) GetAll(ctx domain.RequestContext) (sp []space.Space, err error)
  • func (s Store) GetViewable(ctx domain.RequestContext) (sp []space.Space, err error)
  • func (s Store) PublicSpaces(ctx domain.RequestContext, orgID string) (sp []space.Space, err error)
  • func (s Store) Update(ctx domain.RequestContext, sp space.Space) (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) AcceptInvitation

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

AcceptInvitation records the fact that a user has completed space onboard process.

func (*Handler) Add

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

Add creates a new space.

func (*Handler) Delete

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

Delete removes space.

func (*Handler) Get

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

Get returns the requested space.

func (*Handler) GetAll

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

GetAll returns every space for documize admin users to manage

func (*Handler) GetViewable

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

GetViewable returns spaces the user can see.

func (*Handler) Invite

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

Invite sends users space invitation emails.

func (*Handler) Remove

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

Remove moves documents to another space before deleting it

func (*Handler) Update

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

Update processes request to save space object to the database

type Store

type Store struct {
	store.Context
	store.SpaceStorer
}

Store provides data access to space information.

func (Store) Add

func (s Store) Add(ctx domain.RequestContext, sp space.Space) (err error)

Add adds new folder into the store.

func (Store) Delete

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

Delete removes space from the store.

func (Store) Get

func (s Store) Get(ctx domain.RequestContext, id string) (sp space.Space, err error)

Get returns a space from the store.

func (Store) GetAll

func (s Store) GetAll(ctx domain.RequestContext) (sp []space.Space, err error)

GetAll for admin users!

func (Store) GetViewable

func (s Store) GetViewable(ctx domain.RequestContext) (sp []space.Space, err error)

GetViewable returns spaces that the user can see. Also handles which spaces can be seen by anonymous users.

func (Store) PublicSpaces

func (s Store) PublicSpaces(ctx domain.RequestContext, orgID string) (sp []space.Space, err error)

PublicSpaces returns spaces that anyone can see.

func (Store) Update

func (s Store) Update(ctx domain.RequestContext, sp space.Space) (err error)

Update saves space changes.