policy

Documentation

Index

• type NewGeneratedExamplePolicyRequest
• type PolicySection
• type TableOfContentsItem
• type WebAppPolicy
  • func NewGeneratedExamplePolicy(r *NewGeneratedExamplePolicyRequest) *WebAppPolicy
  • func (w *WebAppPolicy) GetTableOfContentsItems() []TableOfContentsItem

Types

type NewGeneratedExamplePolicyRequest

type NewGeneratedExamplePolicyRequest struct {
	ServiceName       string
	ServiceWebsite    string
	ServiceEmail      string
	LegalBusinessName string
}

NewGeneratedExamplePolicyRequest holds the items needed to generate a new policy

type PolicySection

type PolicySection struct {
	Header          string
	HeaderId        string
	HeaderWithIndex bool
	Paragraphs      []template.HTML
}

PolicySection respresents the components needed to create a section in a policy

type TableOfContentsItem

type TableOfContentsItem struct {
	HeaderHref  string
	HeaderTitle string
}

TableOfContentsItem is the header and its corresponding href reference (internal link)

type WebAppPolicy

type WebAppPolicy struct {
	Name                 string
	LastUpdated          string
	Sections             []PolicySection
	TableOfContentsItems []TableOfContentsItem
}

WebAppPolicy represents the elements needed to construct a valid policy on the web app

func NewGeneratedExamplePolicy

func NewGeneratedExamplePolicy(r *NewGeneratedExamplePolicyRequest) *WebAppPolicy

NewGeneratedExamplePolicy creates a new example web app policy

func (*WebAppPolicy) GetTableOfContentsItems

func (w *WebAppPolicy) GetTableOfContentsItems() []TableOfContentsItem

GetTableOfContentsItems handles looping over the sections provided and pulling out the headers to create the respective splice of headers and corresponding href references