Закладки

Справочник API

Управляйте закладками в стиле браузера со сворачиваемыми группами. Сервер автоматически получает метаданные страницы (заголовок) при добавлении закладки.

Определения типов

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
}

Операции

query

bookmarks

Список всех закладок.

bash

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

query

bookmarkGroups

Список всех групп закладок.

bash

query GetBookmarkGroups {
  bookmarkGroups { id name collapsed sortOrder }
}

mutation

addBookmarks

Добавьте одну или несколько закладок в группу. Сервер запускает событие получения метаданных для каждой закладки, чтобы заполнить заголовок.

bash

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

mutation

updateBookmark

Обновите одно или несколько полей существующей закладки.

bash

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

mutation

deleteBookmarks

Удалите одну или несколько закладок по ID.

bash

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

mutation

recordBookmarkClick

Запишите клик по закладке (используется для аналитики / сортировки "наиболее посещаемые").

bash

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

mutation

createBookmarkGroup

Создайте новую группу закладок.

bash

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

mutation

updateBookmarkGroup

Обновите имя, свёрнутое состояние или порядок сортировки группы закладок.

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

Удалите группу закладок. Закладки внутри не удаляются, только убираются из группы.

bash

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