Tham chiếu API

Bookmarks

Quản lý bookmark kiểu trình duyệt với các nhóm có thể thu gọn. Máy chủ tự động lấy siêu dữ liệu trang (tiêu đề) khi một bookmark được thêm.

Định nghĩa kiểu

bash
type Bookmark {
  id: ID!
  url: String!
  title: String!              # auto-fetched from <title> when available
  groupId: ID!
  pinned: Boolean!
  sortOrder: Int!
  updatedAt: String!
}

type BookmarkGroup {
  id: ID!
  name: String!
  collapsed: Boolean!
  sortOrder: Int!
}

input BookmarkInput {
  url: String
  title: String
  groupId: String
  pinned: Boolean
  sortOrder: Int
}

Thao tác

query

bookmarks

Liệt kê tất cả bookmark.

bash
query GetBookmarks {
  bookmarks { id url title groupId pinned sortOrder updatedAt }
}
query

bookmarkGroups

Liệt kê tất cả nhóm bookmark.

bash
query GetBookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder }
}
mutation

addBookmarks

Thêm một hoặc nhiều bookmark vào một nhóm. Máy chủ kích hoạt sự kiện lấy siêu dữ liệu cho mỗi bookmark để điền tiêu đề.

bash
mutation AddBookmarks($urls: [String!]!, $groupId: String!) {
  addBookmarks(urls: $urls, groupId: $groupId) { id url title groupId pinned sortOrder updatedAt }
}
mutation

updateBookmark

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

bash
mutation UpdateBookmark($id: ID!, $input: BookmarkInput!) {
  updateBookmark(id: $id, input: $input) { id url title groupId pinned sortOrder updatedAt }
}
mutation

deleteBookmarks

Xóa một hoặc nhiều bookmark theo ID.

bash
mutation DeleteBookmarks($ids: [ID!]!) {
  deleteBookmarks(ids: $ids)
}
mutation

recordBookmarkClick

Ghi lại một lượt nhấp vào bookmark (được sử dụng cho phân tích / sắp xếp "ghé thăm nhiều nhất").

bash
mutation RecordBookmarkClick($id: ID!) {
  recordBookmarkClick(id: $id)
}
mutation

createBookmarkGroup

Tạo một nhóm bookmark mới.

bash
mutation CreateBookmarkGroup($name: String!) {
  createBookmarkGroup(name: $name) { id name collapsed sortOrder }
}
mutation

updateBookmarkGroup

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

bash
mutation UpdateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
  updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) {
    id name collapsed sortOrder
  }
}
mutation

deleteBookmarkGroup

Xóa một nhóm bookmark. Bookmark bên trong không bị xóa, chỉ bỏ khỏi nhóm.

bash
mutation DeleteBookmarkGroup($id: ID!) {
  deleteBookmarkGroup(id: $id)
}