doc

Documentation

Index

• type ByTitle
  • func (a ByTitle) Len() int
  • func (a ByTitle) Less(i, j int) bool
  • func (a ByTitle) Swap(i, j int)
• type Document
  • func (d *Document) SetDefaults()
• type DocumentMeta
• type DocumentMetaEditor
• type DocumentMetaViewer
• type SitemapDocument
• type UploadModel

Types

type ByTitle

type ByTitle []Document

ByTitle sorts a collection of documents by document title.

func (ByTitle) Len

func (a ByTitle) Len() int

func (ByTitle) Less

func (a ByTitle) Less(i, j int) bool

func (ByTitle) Swap

func (a ByTitle) Swap(i, j int)

type Document

type Document struct {
	model.BaseEntity
	OrgID      string              `json:"orgId"`
	LabelID    string              `json:"folderId"`
	UserID     string              `json:"userId"`
	Job        string              `json:"job"`
	Location   string              `json:"location"`
	Title      string              `json:"name"`
	Excerpt    string              `json:"excerpt"`
	Slug       string              `json:"-"`
	Tags       string              `json:"tags"`
	Template   bool                `json:"template"`
	Protection workflow.Protection `json:"protection"`
	Approval   workflow.Approval   `json:"approval"`
}

Document represents the purpose of Documize.

func (*Document) SetDefaults

func (d *Document) SetDefaults()

SetDefaults ensures on blanks and cleans.

type DocumentMeta

type DocumentMeta struct {
	Viewers []DocumentMetaViewer `json:"viewers"`
	Editors []DocumentMetaEditor `json:"editors"`
}

DocumentMeta details who viewed the document.

type DocumentMetaEditor

type DocumentMetaEditor struct {
	PageID    string    `json:"pageId"`
	UserID    string    `json:"userId"`
	Action    string    `json:"action"`
	Created   time.Time `json:"created"`
	Firstname string    `json:"firstname"`
	Lastname  string    `json:"lastname"`
}

DocumentMetaEditor contains the "edit" metatdata content.

type DocumentMetaViewer

type DocumentMetaViewer struct {
	UserID    string    `json:"userId"`
	Created   time.Time `json:"created"`
	Firstname string    `json:"firstname"`
	Lastname  string    `json:"lastname"`
}

DocumentMetaViewer contains the "view" metatdata content.

type SitemapDocument

type SitemapDocument struct {
	DocumentID string
	Document   string
	FolderID   string
	Folder     string
	Revised    time.Time
}

SitemapDocument details a document that can be exposed via Sitemap.

type UploadModel

type UploadModel struct {
	JobID string `json:"jobId"`
}

UploadModel details the job ID of an uploaded document.