Bookmarks

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

グループに 1 つ以上のブックマークを追加します。サーバーはタイトルを設定するためにブックマークごとにメタデータ取得イベントを発火します。

bash

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

mutation

updateBookmark

既存のブックマークの 1 つ以上のフィールドを更新します。

bash

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

mutation

deleteBookmarks

ID で 1 つ以上のブックマークを削除します。

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