Documentation ¶
Index ¶
- type Handler
- func (h *Handler) DefaultLogo(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Logo(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Meta(w http.ResponseWriter, r *http.Request)
- func (h *Handler) RobotsTxt(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Sitemap(w http.ResponseWriter, r *http.Request)
- func (h *Handler) Themes(w http.ResponseWriter, r *http.Request)
- type Store
- func (s Store) Attachments(ctx domain.RequestContext, docID string) (a []attachment.Attachment, err error)
- func (s Store) Document(ctx domain.RequestContext, id string) (document doc.Document, err error)
- func (s Store) Documents(ctx domain.RequestContext) (documents []string, err error)
- func (s Store) Pages(ctx domain.RequestContext, documentID string) (p []page.Page, err error)
- func (s Store) SearchIndexCount(ctx domain.RequestContext) (c int, err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
Handler contains the runtime information such as logging and database.
func (*Handler) DefaultLogo ¶
func (h *Handler) DefaultLogo(w http.ResponseWriter, r *http.Request)
DefaultLogo write the default Documize logo to the HTTP response.
func (*Handler) Logo ¶
func (h *Handler) Logo(w http.ResponseWriter, r *http.Request)
Logo returns site logo based upon request domain (e.g. acme.documize.com). The default Documize logo is returned if organization has not uploaded their own logo.
func (*Handler) Meta ¶
func (h *Handler) Meta(w http.ResponseWriter, r *http.Request)
Meta provides org meta data based upon request domain (e.g. acme.documize.com).
func (*Handler) RobotsTxt ¶
func (h *Handler) RobotsTxt(w http.ResponseWriter, r *http.Request)
RobotsTxt returns robots.txt depending on site configuration. Did we allow anonymouse access?
type Store ¶ added in v1.71.0
type Store struct { store.Context store.MetaStorer }
Store provides data access to space category information.
func (Store) Attachments ¶ added in v1.71.0
func (s Store) Attachments(ctx domain.RequestContext, docID string) (a []attachment.Attachment, err error)
Attachments returns a slice containing the attachment records (excluding their data) for document docID, ordered by filename.
func (Store) Document ¶ added in v1.71.0
Document fetches the document record with the given id fromt the document table and audits that it has been got.
func (Store) Documents ¶ added in v1.71.0
func (s Store) Documents(ctx domain.RequestContext) (documents []string, err error)
Documents returns every document ID value stored. For global admins, the query runs at the instance level across all tenants. For tenant admins, the query is restricted to the tenant.
func (Store) Pages ¶ added in v1.71.0
Pages returns a slice containing all published page records for a given documentID, in presentation sequence.
func (Store) SearchIndexCount ¶ added in v1.71.0
func (s Store) SearchIndexCount(ctx domain.RequestContext) (c int, err error)
SearchIndexCount returns the numnber of index entries.