API 参考
书签
通过 app.capabilities 判断功能支持,通过 app.access 和宿主权限判断访问授权。示例使用合成数据,调用前请替换路径、ID、输入和筛选条件。
类型定义
graphql
type Mutation {
addBookmarks(urls: [String!]!, groupId: ID!): [Bookmark!]!
createBookmarkGroup(name: String!): BookmarkGroup!
deleteBookmarkGroup(id: ID!): Boolean!
deleteBookmarks(ids: [ID!]!): ActionResult!
importBookmarks(content: String!): ActionResult!
recordBookmarkClick(id: ID!): Boolean!
updateBookmark(id: ID!, input: BookmarkInput!): Bookmark!
updateBookmarkGroup(id: ID!, name: String!, collapsed: Boolean!, sortOrder: Int!): BookmarkGroup!
}
type Query {
bookmark(id: ID!): Bookmark
bookmarkGroups: [BookmarkGroup!]!
bookmarks: [Bookmark!]!
pageMetadata(url: String!): PageMetadata!
}
type Subscription {
bookmarksUpdated: [Bookmark!]!
}
type ActionResult {
affectedCount: Int!
}
type Bookmark {
id: ID!
url: String!
title: String!
faviconPath: String!
groupId: ID!
pinned: Boolean!
clickCount: Int!
sortOrder: Int!
createdAt: Instant!
updatedAt: Instant!
lastClickedAt: Instant
}
type BookmarkGroup {
id: ID!
name: String!
collapsed: Boolean!
sortOrder: Int!
itemCount: Int!
createdAt: Instant!
updatedAt: Instant!
}
input BookmarkInput {
url: String!
title: String!
faviconUrl: String
groupId: ID!
pinned: Boolean!
sortOrder: Int!
}
scalar Instant
type PageMetadata {
title: String
faviconUrl: String
}操作
mutation
addBookmarks
为传入的 URL 创建书签,并放入指定分组。
graphql
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}mutation
createBookmarkGroup
创建书签分组。
graphql
mutation createBookmarkGroup($name: String!) {
createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}mutation
deleteBookmarkGroup
删除书签分组;组内书签仅取消分组,不会被删除。
graphql
mutation deleteBookmarkGroup($id: ID!) {
deleteBookmarkGroup(id: $id)
}mutation
deleteBookmarks
按 ID 删除一个或多个书签。
graphql
mutation deleteBookmarks($ids: [ID!]!) {
deleteBookmarks(ids: $ids) { affectedCount }
}mutation
importBookmarks
从传入的文档内容导入书签,并返回受影响数量。
graphql
mutation importBookmarks($content: String!) {
importBookmarks(content: $content) { affectedCount }
}mutation
recordBookmarkClick
递增书签已存储的访问次数。
graphql
mutation recordBookmarkClick($id: ID!) {
recordBookmarkClick(id: $id)
}mutation
updateBookmark
更新已有书签的一个或多个字段。
graphql
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}mutation
updateBookmarkGroup
更新书签分组的名称、折叠状态或排序位置。
graphql
mutation updateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) { id name collapsed sortOrder itemCount createdAt updatedAt }
}query
bookmark
按 ID 读取已存储的书签;不存在时返回 null。
graphql
query bookmark($id: ID!) {
bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}query
bookmarkGroups
列出全部书签分组。
graphql
query bookmarkGroups {
bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}query
bookmarks
列出全部书签。
graphql
query bookmarks {
bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}query
pageMetadata
获取网页标题和网站图标 URL,不保存书签。
graphql
query pageMetadata($url: String!) {
pageMetadata(url: $url) { title faviconUrl }
}subscription
bookmarksUpdated
接收更新后的书签记录。
graphql
subscription bookmarksUpdated {
bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}