author

Documentation

Index

• func MapToDB(author Author) db.AuthorDB
• func ToDBAuthor(author *Author) *db.AuthorDB
• type Author
  • func MapFromDB(authorDB db.AuthorDB) Author
  • func NewRandomAuthor() *Author
• type Manager
  • func NewManager(db db.DataStore) *Manager
  • func (m *Manager) CreateAuthor(name *string) (*Author, error)
  • func (m *Manager) GetAuthor(authorId string) (*Author, error)
  • func (m *Manager) GetAuthor4Token(token string) (*Author, error)
  • func (m *Manager) GetAuthorId(token string) (*Author, error)
  • func (m *Manager) GetAuthorName(authorId string) (*string, error)
  • func (m *Manager) GetAuthors(authorIds []string) (*[]Author, error)
  • func (m *Manager) GetPadsOfAuthor(authorId string) (*[]string, error)
  • func (m *Manager) ListPadsOfAuthor(authorId string) ([]string, error)
  • func (m *Manager) SetAuthorColor(author string, colorId string) error
  • func (m *Manager) SetAuthorName(authorId string, authorName string) error

Functions

func MapToDB

func MapToDB(author Author) db.AuthorDB

func ToDBAuthor

func ToDBAuthor(author *Author) *db.AuthorDB

Types

type Author

type Author struct {
	Id        string  `json:"id" example:"a.s8oes9dhwrvt0zif"`
	Name      *string `json:"name" example:"John Doe"`
	ColorId   string  `json:"colorId" example:"#ff0000"`
	Token     *string `json:"token,omitempty"`
	Timestamp int64   `json:"timestamp" example:"1704067200000"`
}

Author represents an Etherpad author @Description An author who can collaborate on pads

func MapFromDB

func MapFromDB(authorDB db.AuthorDB) Author

func NewRandomAuthor

func NewRandomAuthor() *Author

type Manager

type Manager struct {
	Db db.DataStore
}

func NewManager

func NewManager(db db.DataStore) *Manager

func (*Manager) CreateAuthor

func (m *Manager) CreateAuthor(name *string) (*Author, error)

func (*Manager) GetAuthor

func (m *Manager) GetAuthor(authorId string) (*Author, error)

func (*Manager) GetAuthor4Token

func (m *Manager) GetAuthor4Token(token string) (*Author, error)

func (*Manager) GetAuthorId

func (m *Manager) GetAuthorId(token string) (*Author, error)

func (*Manager) GetAuthorName

func (m *Manager) GetAuthorName(authorId string) (*string, error)

*

• Returns the name of the author
• @param {String} author The id of the author

func (*Manager) GetAuthors

func (m *Manager) GetAuthors(authorIds []string) (*[]Author, error)

func (*Manager) GetPadsOfAuthor

func (m *Manager) GetPadsOfAuthor(authorId string) (*[]string, error)

func (*Manager) ListPadsOfAuthor

func (m *Manager) ListPadsOfAuthor(authorId string) ([]string, error)

*

• Returns an array of all pads this author contributed to
• @param {String} authorID The id of the author

func (*Manager) SetAuthorColor

func (m *Manager) SetAuthorColor(author string, colorId string) error

func (*Manager) SetAuthorName

func (m *Manager) SetAuthorName(authorId string, authorName string) error