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 }
}