Tham chiếu API

Dấu trang

Kiểm tra app.capabilities để biết tính năng và app.access cùng quyền máy chủ để xác định quyền truy cập. Thay giá trị mẫu trước khi gọi.

Định nghĩa kiểu

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
}

Thao tác

mutation

addBookmarks

Tạo dấu trang cho các URL được cung cấp trong nhóm đã chỉ định.

graphql
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
  addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}
mutation

createBookmarkGroup

Tạo nhóm dấu trang mới.

graphql
mutation createBookmarkGroup($name: String!) {
  createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}
mutation

deleteBookmarkGroup

Xóa nhóm dấu trang. Dấu trang bên trong không bị xóa, chỉ được bỏ khỏi nhóm.

graphql
mutation deleteBookmarkGroup($id: ID!) {
  deleteBookmarkGroup(id: $id)
}
mutation

deleteBookmarks

Xóa một hoặc nhiều dấu trang theo ID.

graphql
mutation deleteBookmarks($ids: [ID!]!) {
  deleteBookmarks(ids: $ids) { affectedCount }
}
mutation

importBookmarks

Nhập dấu trang từ nội dung tài liệu được cung cấp và báo số bị tác động.

graphql
mutation importBookmarks($content: String!) {
  importBookmarks(content: $content) { affectedCount }
}
mutation

recordBookmarkClick

Tăng số lượt truy cập đã lưu của dấu trang.

graphql
mutation recordBookmarkClick($id: ID!) {
  recordBookmarkClick(id: $id)
}
mutation

updateBookmark

Cập nhật một hoặc nhiều trường của dấu trang hiện có.

graphql
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
  updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}
mutation

updateBookmarkGroup

Cập nhật tên, trạng thái thu gọn hoặc thứ tự sắp xếp nhóm dấu trang.

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

Đọc một dấu trang đã lưu theo ID; trả về null nếu không có.

graphql
query bookmark($id: ID!) {
  bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}
query

bookmarkGroups

Liệt kê mọi nhóm dấu trang.

graphql
query bookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}
query

bookmarks

Liệt kê mọi dấu trang.

graphql
query bookmarks {
  bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}
query

pageMetadata

Lấy tiêu đề và URL favicon của trang web mà không lưu dấu trang.

graphql
query pageMetadata($url: String!) {
  pageMetadata(url: $url) { title faviconUrl }
}
subscription

bookmarksUpdated

Nhận bản ghi dấu trang đã cập nhật.

graphql
subscription bookmarksUpdated {
  bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}