space

Documentation

Index

• type AcceptShareModel
• type InvitationModel
• type NewSpaceRequest
• type Scope
• type Space
  • func (l *Space) IsPrivate() bool
  • func (l *Space) IsPublic() bool
  • func (l *Space) IsRestricted() bool
• type Viewer

Types

type AcceptShareModel

type AcceptShareModel struct {
	Serial    string `json:"serial"`
	Firstname string `json:"firstname"`
	Lastname  string `json:"lastname"`
	Password  string `json:"password"`
}

AcceptShareModel is used to setup a user who has accepted a shared space.

type InvitationModel

type InvitationModel struct {
	Message    string
	Recipients []string
}

InvitationModel details which users have been invited to a space.

type NewSpaceRequest

type NewSpaceRequest struct {
	Name           string `json:"name"`
	CloneID        string `json:"cloneId"`        // existing space to clone, empty = no cloning
	CopyTemplate   bool   `json:"copyTemplate"`   // copy templates and reusable content blocks
	CopyPermission bool   `json:"copyPermission"` // copy uer permissions
	CopyDocument   bool   `json:"copyDocument"`   // copy all documents!
}

NewSpaceRequest details the new space to create.

type Scope

type Scope int

Scope determines folder visibility.

const (
	// ScopePublic can be seen by anyone
	ScopePublic Scope = 1

	// ScopePrivate can only be seen by the person who owns it
	ScopePrivate Scope = 2

	// ScopeRestricted can be seen by selected users
	ScopeRestricted Scope = 3
)

type Space

type Space struct {
	model.BaseEntity
	Name   string `json:"name"`
	OrgID  string `json:"orgId"`
	UserID string `json:"userId"`
	Type   Scope  `json:"folderType"`

	// Lifecycle stores the default value all new documents are given upon creation.
	Lifecycle workflow.Lifecycle `json:"lifecycle"`

	// Likes stores the question to ask the user such as 'Did this help you?'.
	// An empty value tells us liking is not allowed.
	Likes string `json:"likes"`
}

Space defines a container for documents.

func (*Space) IsPrivate

func (l *Space) IsPrivate() bool

IsPrivate means the folder can only be seen by the person who owns it.

func (*Space) IsPublic

func (l *Space) IsPublic() bool

IsPublic means the folder can be seen by anyone.

func (*Space) IsRestricted

func (l *Space) IsRestricted() bool

IsRestricted means the folder can be seen by selected users.

type Viewer

type Viewer struct {
	Name      string `json:"name"`
	LabelID   string `json:"folderId"`
	Type      int    `json:"folderType"`
	UserID    string `json:"userId"`
	Firstname string `json:"firstname"`
	Lastname  string `json:"lastname"`
	Email     string `json:"email"`
}

Viewer details who can see a particular space