abc

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2019 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type IYuque added in v0.0.4

type IYuque interface {
	Auth(token string) IYuque
	Group() YuQueGroup
	User() YuQueUser
	Repo() YuQueRepo
	Doc() YuQueDoc
}

type YuQueDoc

type YuQueDoc interface {
	// 获取一个仓库的文档列表
	GetDocs(RepoId string) (_ []*models.Doc, err error)
	GetDocsByName(RepoName string) (_ []*models.Doc, err error)
	// 创建文档
	CreateDoc(RepoId string) func(create *models.DocCreate) (_ *models.Doc, err error)
	CreateDocByName(RepoName string) func(create *models.DocCreate) (_ *models.Doc, err error)
	// 更新文档
	UpdateDoc(RepoId string, DocId string) func(create *models.DocCreate) (_ *models.Doc, err error)
	UpdateDocByName(RepoName string, DocId string) func(create *models.DocCreate) (_ *models.Doc, err error)
	// 获取单篇文档的详细信息
	GetDoc(RepoId string, DocId string) (_ *models.Doc, err error)
	GetDocByName(RepoName string, DocId string) (_ *models.Doc, err error)
	// 删除文档
	DelDoc(RepoId string, DocId string) (_ *models.Doc, err error)
	DelDocByName(RepoName string, DocId string) (_ *models.Doc, err error)
}

type YuQueGroup

type YuQueGroup interface {
	// 获取某个用户的加入的组织列表
	GetUserGroups(userId string) (_ []*models.Group, err error)
	GetUserGroupsByName(username string) (_ []*models.Group, err error)
	// 获取公开组织列表
	GetMyPubGroups() (_ []*models.Group, err error)
	// 创建组织
	CreateGroup(group *models.GroupCreate) (_ *models.GroupDetail, err error)
	// 获取单个组织的详细信息
	GetGroup(groupId string) (_ *models.GroupDetail, err error)
	GetGroupByName(groupName string) (_ *models.GroupDetail, err error)
	// 更新单个组织的详细信息
	UpdateGroup(groupId string) func(group *models.GroupCreate) (_ *models.GroupDetail, err error)
	UpdateGroupByName(groupName string) func(group *models.GroupCreate) (_ *models.GroupDetail, err error)
	// 删除组织
	// 此接口仅会删除 Group 基本信息,其他有关的仓库、文档、画板均保持不动,以避免误删除以后需要恢复
	DelGroup(groupId string) (_ *models.GroupDetail, err error)
	DelGroupByName(groupName string) (_ *models.GroupDetail, err error)
	// 获取组织成员信息
	// 需要 abilities.group.read 权限
	GetGroupMembers(groupId string) (_ []*models.GroupUser, err error)
	GetGroupMembersByName(groupName string) (_ []*models.GroupUser, err error)
	// 增加或更新组织成员
	// 需要 abilities.group_user.read 权限
	// 需要有 abilities.group_user.create 权限
	// role 为 0 的时候,需要 abilities.group_user.update 权限
	UpdateGroupMember(groupId, userName string) func(_ *models.GroupCreate) (_ *models.GroupUser, err error)
	UpdateGroupMemberByName(groupName, userName string) func(_ *models.GroupCreate) (_ *models.GroupUser, err error)
	// 删除组织成员
	// 需要有 abilities.group_user.destroy 权限
	// 不可以自己删除自己
	DelGroupMember(groupId, userName string) (_ *models.GroupUser, err error)
	DelGroupMemberByName(groupName, userName string) (_ *models.GroupUser, err error)
}

type YuQueRepo

type YuQueRepo interface {
	// 获取一个仓库的文档列表
	GetUserRepos(userId string) func(string, int) (_ []*models.Book, err error)
	GetUserReposByName(username string) func(string, int) (_ []*models.Book, err error)
	GetGroupRepos(groupId string) func(string, int) (_ []*models.Book, err error)
	GetGroupReposByName(groupName string) func(string, int) (_ []*models.Book, err error)
	// 往自己下面创建仓库
	// 需要 Group 的 abilities.repo.create 权限
	CreateUserRepo(userId string) func(data *models.BookCreate) (_ *models.Book, err error)
	CreateUserRepoByName(username string) func(data *models.BookCreate) (_ *models.Book, err error)
	// 创建新仓库
	// 往组织创建仓库
	CreateGroupRepo(groupId string) func(data *models.BookCreate) (_ *models.Book, err error)
	CreateGroupRepoByName(groupName string) func(data *models.BookCreate) (_ *models.Book, err error)
	// 获取仓库详情
	GetRepo(repoId string) func(string) (_ *models.Book, err error)
	GetRepoByName(repoName string) func(string) (_ *models.Book, err error)
	// 更新仓库信息
	// 需要 Repo 的 abilities.update 权限
	UpdateRepo(repoId string) func(*models.BookCreate) (_ *models.Book, err error)
	UpdateRepoByName(repoName string) func(*models.BookCreate) (_ *models.Book, err error)
	// 删除仓库
	// 需要 Repo 的 abilities.destroy 权限
	DelRepo(repoId string) (_ *models.Book, err error)
	DelByName(repoName string) (_ *models.Book, err error)
	// 获取一个仓库的目录结构
	// 需要 Repo 的 abilities.read 权限
	// 如果是 Group 成员,将能获取到私密文档、未发布的草稿
	GetRepoToc(repoId string) (_ *models.BookToc, err error)
	GetRepoTocByName(repoName string) (_ *models.BookToc, err error)
	// 基于关键字搜索仓库
	// 无法搜索到私密仓库
	SearchRepo(q, typ string) (_ *models.Search, err error)
}

type YuQueUser

type YuQueUser interface {
	// 获取认证的用户的个人信息 [需要认证]
	// 获取当前 Token 对应的用户的个人信息
	// 返回结果如同 GET /users/:login
	GetMe() (res *models.UserDetail, err error)

	// 获取单个用户信息
	// 基于用户 login 或 id 获取一个用户的基本信息
	GetUser(userId string) (res *models.UserDetail, err error)
	GetUserByName(username string) (res *models.UserDetail, err error)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL