API-Referenz

Lesezeichen

Browser-artige Lesezeichen mit einklappbaren Gruppen verwalten. Der Server ruft automatisch Seiten-Metadaten (Titel) ab, wenn ein Lesezeichen hinzugefügt wird.

Typdefinitionen

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
}

Operationen

query

bookmarks

Alle Lesezeichen auflisten.

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

bookmarkGroups

Alle Lesezeichen-Gruppen auflisten.

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

addBookmarks

Ein oder mehrere Lesezeichen zu einer Gruppe hinzufügen. Der Server feuert ein Metadaten-Abruf-Ereignis pro Lesezeichen, um den Titel zu füllen.

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

updateBookmark

Ein oder mehrere Felder eines bestehenden Lesezeichens aktualisieren.

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

deleteBookmarks

Ein oder mehrere Lesezeichen anhand der ID löschen.

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

recordBookmarkClick

Einen Klick auf ein Lesezeichen erfassen (für Analytik / "Meistbesucht"-Sortierung).

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

createBookmarkGroup

Eine neue Lesezeichen-Gruppe erstellen.

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

updateBookmarkGroup

Name, eingeklappt-Zustand oder Sortierreihenfolge einer Lesezeichen-Gruppe aktualisieren.

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

Eine Lesezeichen-Gruppe löschen. Lesezeichen darin werden nicht gelöscht, nur aus der Gruppe entfernt.

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