document

Documentation

Index

• func BuildExport(ctx domain.RequestContext, s domain.Store, spec exportSpec) (html string, err error)
• func CopyDocument(ctx domain.RequestContext, s domain.Store, documentID string) (newDocumentID string, err error)
• func FilterCategoryProtected(docs []doc.Document, cats []category.Category, members []category.Member, ...) (filtered []doc.Document)
• func FilterLastVersion(docs []doc.Document) (filtered []doc.Document)
• type BulkDocumentData
• type Handler
  • func (h *Handler) BySpace(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Delete(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) DocumentLinks(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Export(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) FetchDocumentData(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Get(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) SearchDocuments(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Update(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) Vote(w http.ResponseWriter, r *http.Request)

Functions

func BuildExport

func BuildExport(ctx domain.RequestContext, s domain.Store, spec exportSpec) (html string, err error)

BuildExport generates self-enclosed HTML for content specified.

func CopyDocument

func CopyDocument(ctx domain.RequestContext, s domain.Store, documentID string) (newDocumentID string, err error)

CopyDocument clones an existing document

func FilterCategoryProtected

func FilterCategoryProtected(docs []doc.Document, cats []category.Category, members []category.Member, viewDrafts bool) (filtered []doc.Document)

FilterCategoryProtected removes documents that cannot be seen by user due to document cateogory viewing permissions.

func FilterLastVersion

func FilterLastVersion(docs []doc.Document) (filtered []doc.Document)

FilterLastVersion returns the latest version of each document by removing all previous versions. If a document is not versioned, it is returned as-is.

Types

type BulkDocumentData

type BulkDocumentData struct {
	Document    doc.Document      `json:"document"`
	Permissions pm.Record         `json:"permissions"`
	Roles       pm.DocumentRecord `json:"roles"`
	Spaces      []space.Space     `json:"folders"`
	Links       []link.Link       `json:"links"`
	Versions    []doc.Version     `json:"versions"`
}

BulkDocumentData represents all data associated for a single document. Used by FetchDocumentData() bulk data load call.

type Handler

type Handler struct {
	Runtime *env.Runtime
	Store   *domain.Store
	Indexer indexer.Indexer
}

Handler contains the runtime information such as logging and database.

func (*Handler) BySpace

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

BySpace is an endpoint that returns the documents for given space.

func (*Handler) Delete

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

Delete is an endpoint that deletes a document specified by documentID.

func (*Handler) DocumentLinks

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

DocumentLinks is an endpoint returning the links for a document.

func (*Handler) Export

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

Export returns content as self-enclosed HTML file.

func (*Handler) FetchDocumentData

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

FetchDocumentData returns all document data in single API call.

func (*Handler) Get

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

Get is an endpoint that returns the document-level information for a given documentID.

func (*Handler) SearchDocuments

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

SearchDocuments endpoint takes a list of keywords and returns a list of document references matching those keywords.

func (*Handler) Update

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

Update updates an existing document using the format described in NewDocumentModel() encoded as JSON in the request.

func (*Handler) Vote

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

Vote records document content vote, Yes, No. Anonymous users should be assigned a temporary ID